class SOCKS::Session

Defined in:

socks/session.cr

Constructors

Instance Method Summary

Class methods inherited from class IO

yield_copy(src : IO, dst : IO, &block : Int64, Int32 -> ) : Int64 yield_copy

Constructor Detail

def self.new(inbound : IO, options : Options) #

[View source]

Instance Method Detail

def check_authorization!(server : Server, request : HTTP::Request, response : HTTP::Server::Response) #

[View source]
def cleanup(sd_flag : Transfer::SDFlag, reset : Bool = true) #

[View source]
def cleanup : Bool #

[View source]
def close #
Description copied from class IO

Closes this IO.

IO defines this is a no-op method, but including types may override.


[View source]
def closed? #
Description copied from class IO

Returns true if this IO is closed.

IO defines returns false, but including types may override.


[View source]
def connection_identifier : UUID? #

[View source]
def connection_identifier=(value : UUID) #

[View source]
def connection_pause_pending=(value : Bool | Nil) #

[View source]
def connection_pause_pending? : Bool | Nil #

[View source]
def exchangeFrames : Set(Frames) #

[View source]
def exchangeFrames=(exchangeFrames : Set(Frames)) #

[View source]
def holding : IO | Nil #

[View source]
def holding=(holding : IO | Nil) #

[View source]
def inbound : IO #

[View source]
def inbound=(inbound : IO) #

[View source]
def local_address : Socket::Address | Nil #

[View source]
def options : Options #

[View source]
def outbound : IO | Nil #

[View source]
def outbound=(outbound : IO | Nil) #

[View source]
def process_upgrade!(server : Server, pause_pool : PausePool | Nil = nil) : HTTP::Request | Nil #

[View source]
def read(slice : Bytes) : Int32 #
Description copied from class IO

Reads at most slice.size bytes from this IO into slice. Returns the number of bytes read, which is 0 if and only if there is no more data to read (so checking for 0 is the way to detect end of file).

io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice          # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice          # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0

[View source]
def read_timeout #

[View source]
def read_timeout=(value : Int | Time::Span | Nil) #

[View source]
def remote_address : Socket::Address | Nil #

[View source]
def reset_socket(sd_flag : Transfer::SDFlag) #

[View source]
def reset_socket #

[View source]
def state : Enhanced::State::WebSocket | Nil #

[View source]
def state=(value : Enhanced::State::WebSocket | Nil) #

[View source]
def syncCloseOutbound : Bool #

[View source]
def syncCloseOutbound=(syncCloseOutbound : Bool) #

[View source]
def write(slice : Bytes) : Nil #
Description copied from class IO

Writes the contents of slice into this IO.

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"

[View source]
def write_timeout #

[View source]
def write_timeout=(value : Int | Time::Span | Nil) #

[View source]