OFTCPSocket Class Reference

A class which provides functions to create and use TCP sockets. More...

#import <ObjFW/OFTCPSocket.h>

Inheritance diagram for OFTCPSocket:

Instance Methods
(void)	- setSOCKS5Host:
	Sets the host to use as a SOCKS5 proxy. More...
(nullable OFString *)	- SOCKS5Host
	Returns the host to use as a SOCKS5 proxy. More...
(void)	- setSOCKS5Port:
	Sets the port to use on the SOCKS5 proxy. More...
(uint16_t)	- SOCKS5Port
	Returns the port to use on the SOCKS5 proxy. More...
(void)	- connectToHost:port:
	Connect the OFTCPSocket to the specified destination. More...
(void)	- asyncConnectToHost:port:target:selector:
	Asyncronously connect the OFTCPSocket to the specified destination. More...
(void)	- asyncConnectToHost:port:block:
	Asyncronously connect the OFTCPSocket to the specified destination. More...
(uint16_t)	- bindToHost:port:
	Bind the socket to the specified host and port. More...
(void)	- listenWithBackLog:
	Listen on the socket. More...
(void)	- listen
	Listen on the socket.
(instancetype)	- accept
	Accept an incoming connection. More...
(void)	- asyncAcceptWithTarget:selector:
	Asyncronously accept an incoming connection. More...
(void)	- asyncAcceptWithBlock:
	Asyncronously accept an incoming connection. More...
(nullable OFString *)	- remoteAddress
	Returns the remote address of the socket. More...
(bool)	- isListening
	Returns whether the socket is a listening socket. More...
(void)	- setKeepAliveEnabled:
	Enable or disable keep alive for the connection. More...
(bool)	- isKeepAliveEnabled
	Returns whether keep alive is enabled for the connection. More...
(void)	- setTCPNoDelayEnabled:
	Enable or disable TCP_NODELAY for the connection. More...
(bool)	- isTCPNoDelayEnabled
	Returns whether TCP_NODELAY is enabled for the connection. More...
Instance Methods inherited from OFStream
(bool)	- isAtEndOfStream
	Returns a boolean whether the end of the stream has been reached. More...
(size_t)	- readIntoBuffer:length:
	Reads at most size bytes from the stream into a buffer. More...
(void)	- readIntoBuffer:exactLength:
	Reads exactly the specified length bytes from the stream into a buffer. More...
(void)	- asyncReadIntoBuffer:length:target:selector:
	Asyncronously reads at most size bytes from the stream into a buffer. More...
(void)	- asyncReadIntoBuffer:exactLength:target:selector:
	Asyncronously reads exactly the specified length bytes from the stream into a buffer. More...
(void)	- asyncReadIntoBuffer:length:block:
	Asyncronously reads at most ref size bytes from the stream into a buffer. More...
(void)	- asyncReadIntoBuffer:exactLength:block:
	Asyncronously reads exactly the specified length bytes from the stream into a buffer. More...
(uint8_t)	- readInt8
	Reads a uint8_t from the stream. More...
(uint16_t)	- readBigEndianInt16
	Reads a uint16_t from the stream which is encoded in big endian. More...
(uint32_t)	- readBigEndianInt32
	Reads a uint32_t from the stream which is encoded in big endian. More...
(uint64_t)	- readBigEndianInt64
	Reads a uint64_t from the stream which is encoded in big endian. More...
(float)	- readBigEndianFloat
	Reads a float from the stream which is encoded in big endian. More...
(double)	- readBigEndianDouble
	Reads a double from the stream which is encoded in big endian. More...
(size_t)	- readBigEndianInt16sIntoBuffer:count:
	Reads the specified number of uint16_ts from the stream which are encoded in big endian. More...
(size_t)	- readBigEndianInt32sIntoBuffer:count:
	Reads the specified number of uint32_ts from the stream which are encoded in big endian. More...
(size_t)	- readBigEndianInt64sIntoBuffer:count:
	Reads the specified number of uint64_ts from the stream which are encoded in big endian. More...
(size_t)	- readBigEndianFloatsIntoBuffer:count:
	Reads the specified number of floats from the stream which are encoded in big endian. More...
(size_t)	- readBigEndianDoublesIntoBuffer:count:
	Reads the specified number of doubles from the stream which are encoded in big endian. More...
(uint16_t)	- readLittleEndianInt16
	Reads a uint16_t from the stream which is encoded in little endian. More...
(uint32_t)	- readLittleEndianInt32
	Reads a uint32_t from the stream which is encoded in little endian. More...
(uint64_t)	- readLittleEndianInt64
	Reads a uint64_t from the stream which is encoded in little endian. More...
(float)	- readLittleEndianFloat
	Reads a float from the stream which is encoded in little endian. More...
(double)	- readLittleEndianDouble
	Reads a double from the stream which is encoded in little endian. More...
(size_t)	- readLittleEndianInt16sIntoBuffer:count:
	Reads the specified number of uint16_ts from the stream which are encoded in little endian. More...
(size_t)	- readLittleEndianInt32sIntoBuffer:count:
	Reads the specified number of uint32_ts from the stream which are encoded in little endian. More...
(size_t)	- readLittleEndianInt64sIntoBuffer:count:
	Reads the specified number of uint64_ts from the stream which are encoded in little endian. More...
(size_t)	- readLittleEndianFloatsIntoBuffer:count:
	Reads the specified number of floats from the stream which are encoded in little endian. More...
(size_t)	- readLittleEndianDoublesIntoBuffer:count:
	Reads the specified number of doubles from the stream which are encoded in little endian. More...
(OFDataArray *)	- readDataArrayWithCount:
	Reads the specified number of items with an item size of 1 from the stream and returns them in an OFDataArray. More...
(OFDataArray *)	- readDataArrayWithItemSize:count:
	Reads the specified number of items with the specified item size from the stream and returns them in an OFDataArray. More...
(OFDataArray *)	- readDataArrayTillEndOfStream
	Returns an OFDataArray with all the remaining data of the stream. More...
(OFString *)	- readStringWithLength:
	Reads a string with the specified length from the stream. More...
(OFString *)	- readStringWithLength:encoding:
	Reads a string with the specified encoding and length from the stream. More...
(nullable OFString *)	- readLine
	Reads until a newline, \0 or end of stream occurs. More...
(nullable OFString *)	- readLineWithEncoding:
	Reads with the specified encoding until a newline, \0 or end of stream occurs. More...
(void)	- asyncReadLineWithTarget:selector:
	Asyncronously reads until a newline, \0, end of stream or an exception occurs. More...
(void)	- asyncReadLineWithEncoding:target:selector:
	Asyncronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs. More...
(void)	- asyncReadLineWithBlock:
	Asyncronously reads until a newline, \0, end of stream or an exception occurs. More...
(void)	- asyncReadLineWithEncoding:block:
	Asyncronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs. More...
(nullable OFString *)	- tryReadLine
	Tries to read a line from the stream (see readLine) and returns nil if no complete line has been received yet. More...
(nullable OFString *)	- tryReadLineWithEncoding:
	Tries to read a line from the stream with the specified encoding (see readLineWithEncoding:) and returns nil if no complete line has been received yet. More...
(nullable OFString *)	- readTillDelimiter:
	Reads until the specified string or \0 is found or the end of stream occurs. More...
(nullable OFString *)	- readTillDelimiter:encoding:
	Reads until the specified string or \0 is found or the end of stream occurs. More...
(nullable OFString *)	- tryReadTillDelimiter:
	Tries to reads until the specified string or \0 is found or the end of stream (see readTillDelimiter:) and returns nil if not enough data has been received yet. More...
(nullable OFString *)	- tryReadTillDelimiter:encoding:
	Tries to read until the specified string or \0 is found or the end of stream occurs (see readTillDelimiter:encoding:) and returns nil if not enough data has been received yet. More...
(bool)	- isWriteBuffered
	Returns a boolen whether writes are buffered. More...
(void)	- setWriteBuffered:
	Enables or disables the write buffer. More...
(void)	- flushWriteBuffer
	Writes everythig in the write buffer to the stream.
(void)	- writeBuffer:length:
	Writes from a buffer into the stream. More...
(void)	- writeInt8:
	Writes a uint8_t into the stream. More...
(void)	- writeBigEndianInt16:
	Writes a uint16_t into the stream, encoded in big endian. More...
(void)	- writeBigEndianInt32:
	Writes a uint32_t into the stream, encoded in big endian. More...
(void)	- writeBigEndianInt64:
	Writes a uint64_t into the stream, encoded in big endian. More...
(void)	- writeBigEndianFloat:
	Writes a float into the stream, encoded in big endian. More...
(void)	- writeBigEndianDouble:
	Writes a double into the stream, encoded in big endian. More...
(size_t)	- writeBigEndianInt16s:count:
	Writes the specified number of uint16_ts into the stream, encoded in big endian. More...
(size_t)	- writeBigEndianInt32s:count:
	Writes the specified number of uint32_ts into the stream, encoded in big endian. More...
(size_t)	- writeBigEndianInt64s:count:
	Writes the specified number of uint64_ts into the stream, encoded in big endian. More...
(size_t)	- writeBigEndianFloats:count:
	Writes the specified number of floats into the stream, encoded in big endian. More...
(size_t)	- writeBigEndianDoubles:count:
	Writes the specified number of doubles into the stream, encoded in big endian. More...
(void)	- writeLittleEndianInt16:
	Writes a uint16_t into the stream, encoded in little endian. More...
(void)	- writeLittleEndianInt32:
	Writes a uint32_t into the stream, encoded in little endian. More...
(void)	- writeLittleEndianInt64:
	Writes a uint64_t into the stream, encoded in little endian. More...
(void)	- writeLittleEndianFloat:
	Writes a float into the stream, encoded in little endian. More...
(void)	- writeLittleEndianDouble:
	Writes a double into the stream, encoded in little endian. More...
(size_t)	- writeLittleEndianInt16s:count:
	Writes the specified number of uint16_ts into the stream, encoded in little endian. More...
(size_t)	- writeLittleEndianInt32s:count:
	Writes the specified number of uint32_ts into the stream, encoded in little endian. More...
(size_t)	- writeLittleEndianInt64s:count:
	Writes the specified number of uint64_ts into the stream, encoded in little endian. More...
(size_t)	- writeLittleEndianFloats:count:
	Writes the specified number of floats into the stream, encoded in little endian. More...
(size_t)	- writeLittleEndianDoubles:count:
	Writes the specified number of doubles into the stream, encoded in little endian. More...
(size_t)	- writeDataArray:
	Writes from an OFDataArray into the stream. More...
(size_t)	- writeString:
	Writes a string into the stream, without the trailing zero. More...
(size_t)	- writeString:encoding:
	Writes a string into the stream in the specified encoding, without the trailing zero. More...
(size_t)	- writeLine:
	Writes a string into the stream with a trailing newline. More...
(size_t)	- writeLine:encoding:
	Writes a string into the stream in the specified encoding with a trailing newline. More...
(size_t)	- writeFormat:
	Writes a formatted string into the stream. More...
(size_t)	- writeFormat:arguments:
	Writes a formatted string into the stream. More...
(bool)	- hasDataInReadBuffer
	Returns whether data is present in the internal read buffer. More...
(bool)	- isBlocking
	Returns whether the stream is in blocking mode. More...
(void)	- setBlocking:
	Enables or disables non-blocking I/O. More...
(int)	- fileDescriptorForReading
	Returns the file descriptor for the read end of the stream. More...
(int)	- fileDescriptorForWriting
	Returns the file descriptor for the write end of the stream. More...
(void)	- cancelAsyncRequests
	Cancels all pending asyncronous requests on the stream. More...
(void)	- unreadFromBuffer:length:
	"Reverses" a read operation, meaning the bytes from the specified buffer will be returned on the next read operation. More...
(void)	- close
	Closes the stream.
(size_t)	- lowlevelReadIntoBuffer:length:
	Performs a lowlevel read. More...
(void)	- lowlevelWriteBuffer:length:
	Performs a lowlevel write. More...
(bool)	- lowlevelIsAtEndOfStream
	Returns whether the lowlevel is at the end of the stream. More...
Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object. More...
(OFString *)	- className
	Returns the name of the object's class. More...
(OFString *)	- description
	Returns a description for the object. More...
(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool. More...
(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool. More...
(nullable void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size. More...
(nullable void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool. More...
(void)	- dealloc
	Deallocates the object. More...
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay. More...
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay. More...
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay. More...
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread. More...
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object. More...
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects. More...
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread. More...
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object. More...
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects. More...
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay. More...
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay. More...
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded. More...
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver. More...
(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver. More...
Instance Methods inherited from <OFObject>
(bool)	- isKindOfClass:
	Returns a boolean whether the object of the specified kind. More...
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class. More...
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector. More...
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector. More...
(nullable const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector. More...
(nullable id)	- performSelector:
	Performs the specified selector. More...
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object. More...
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects. More...
(bool)	- isEqual:
	Checks two objects for equality. More...
(uint32_t)	- hash
	Calculates a hash for the object. More...
(id)	- retain
	Increases the retain count. More...
(unsigned int)	- retainCount
	Returns the retain count. More...
(void)	- release
	Decreases the retain count. More...
(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
(id)	- self
	Returns the receiver. More...
(bool)	- isProxy
	Returns whether the object is a proxy object. More...
Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object. More...

Class Methods
(void)	+ setSOCKS5Host:
	Sets the global SOCKS5 proxy host to use when creating a new socket. More...
(nullable OFString *)	+ SOCKS5Host
	Returns the host to use as a SOCKS5 proxy when creating a new socket. More...
(void)	+ setSOCKS5Port:
	Sets the global SOCKS5 proxy port to use when creating a new socket. More...
(uint16_t)	+ SOCKS5Port
	Returns the port to use as a SOCKS5 proxy when creating a new socket. More...
Class Methods inherited from OFStreamSocket
(instancetype)	+ socket
	Returns a new, autoreleased OFTCPSocket. More...
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime. More...
(void)	+ unload
	A method which is called when the class is unloaded from the runtime. More...
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made. More...
(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object. More...
(id)	+ new
	Allocates memory for a new instance and calls init on it. More...
(Class)	+ class
	Returns the class. More...
(OFString *)	+ className
	Returns the name of the class as a string. More...
(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class. More...
(Class)	+ superclass
	Returns the superclass of the class. More...
(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector. More...
(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol. More...
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector. More...
(nullable const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector. More...
(OFString *)	+ description
	Returns a description for the class, which is usually the class name. More...
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class. More...
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class. More...
(nullable IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method. More...
(nullable IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method. More...
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver. More...
(bool)	+ resolveClassMethod:
	Try to resolve the specified class method. More...
(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method. More...
(id)	+ copy
	Returns the class. More...

Detailed Description

A class which provides functions to create and use TCP sockets.

To connect to a server, create a socket and connect it. To create a server, create a socket, bind it and listen on it.

Method Documentation

- (instancetype) accept

Accept an incoming connection.

Returns

An autoreleased OFTCPSocket for the accepted connection.

- (void) asyncAcceptWithBlock:

(of_tcp_socket_async_accept_block_t)

block

Asyncronously accept an incoming connection.

Parameters

block

The block to execute when a new connection has been accepted. Returns whether the next incoming connection should be accepted by the specified block as well.

- (void) asyncAcceptWithTarget:		(id)	target
selector:		(SEL)	selector

Asyncronously accept an incoming connection.

Parameters

target	The target on which to execute the selector when a new connection has been accepted. The method returns whether the next incoming connection should be accepted by the specified block as well.
selector	The selector to call on the target. The signature must be bool (OFTCPSocket *socket, OFTCPSocket *acceptedSocket, OFException *exception).

- (void) asyncConnectToHost:		(OFString*)	host
port:		(uint16_t)	port
block:		(of_tcp_socket_async_connect_block_t)	block

Asyncronously connect the OFTCPSocket to the specified destination.

Parameters

host	The host to connect to
port	The port on the host to connect to
block	The block to execute once the connection has been established

- (void) asyncConnectToHost:		(OFString*)	host
port:		(uint16_t)	port
target:		(id)	target
selector:		(SEL)	selector

Asyncronously connect the OFTCPSocket to the specified destination.

Parameters

host	The host to connect to
port	The port on the host to connect to
target	The target on which to call the selector once the connection has been established
selector	The selector to call on the target. The signature must be void (OFTCPSocket *socket, OFException *exception).

- (uint16_t) bindToHost:		(OFString*)	host
port:		(uint16_t)	port

Bind the socket to the specified host and port.

Parameters

host	The host to bind to. Use @"0.0.0.0" for IPv4 or @"::" for IPv6 to bind to all.
port	The port to bind to. If the port is 0, an unused port will be chosen, which can be obtained using the return value.

Returns

The port the socket was bound to

- (void) connectToHost:		(OFString*)	host
port:		(uint16_t)	port

Connect the OFTCPSocket to the specified destination.

Parameters

host	The host to connect to
port	The port on the host to connect to

- (bool) isKeepAliveEnabled

Returns whether keep alive is enabled for the connection.

Returns

Whether keep alives are enabled for the connection

- (bool) isListening

Returns whether the socket is a listening socket.

Returns

Whether the socket is a listening socket

- (bool) isTCPNoDelayEnabled

Returns whether TCP_NODELAY is enabled for the connection.

Returns

Whether TCP_NODELAY is enabled for the connection

- (void) listenWithBackLog:

(int)

backLog

Listen on the socket.

Parameters

backLog

Maximum length for the queue of pending connections.

- (OFString *) remoteAddress

Returns the remote address of the socket.

Only works with accepted sockets!

Returns

The remote address as a string

- (void) setKeepAliveEnabled:

(bool)

enabled

Enable or disable keep alive for the connection.

Parameters

enabled

Whether to enable or disable keep alives for the connection

- (void) setSOCKS5Host:

(nullable OFString *)

host

Sets the host to use as a SOCKS5 proxy.

Parameters

host	The host to use as a SOCKS5 proxy

+ (void) setSOCKS5Host:

(nullable OFString *)

SOCKS5Host

Sets the global SOCKS5 proxy host to use when creating a new socket.

Parameters

SOCKS5Host

The host to use as a SOCKS5 proxy when creating a new socket

- (void) setSOCKS5Port:

(uint16_t)

port

Sets the port to use on the SOCKS5 proxy.

The default port is 1080.

Parameters

port	The port to use on the SOCKS5 proxy

+ (void) setSOCKS5Port:

(uint16_t)

SOCKS5Port

Sets the global SOCKS5 proxy port to use when creating a new socket.

Parameters

SOCKS5Port

The port to use as a SOCKS5 proxy when creating a new socket

- (void) setTCPNoDelayEnabled:

(bool)

enabled

Enable or disable TCP_NODELAY for the connection.

Parameters

enabled

Whether to enable or disable TCP_NODELAY for the connection

+ (OFString *) SOCKS5Host

Returns the host to use as a SOCKS5 proxy when creating a new socket.

Returns

The host to use as a SOCKS5 proxy when creating a new socket

- (nullable OFString*) SOCKS5Host

Returns the host to use as a SOCKS5 proxy.

Returns

The host to use as a SOCKS5 proxy

+ (uint16_t) SOCKS5Port

Returns the port to use as a SOCKS5 proxy when creating a new socket.

Returns

The port to use as a SOCKS5 proxy when creating a new socket

- (uint16_t) SOCKS5Port

Returns the port to use on the SOCKS5 proxy.

Returns

The port to use on the SOCKS5 proxy

---

The documentation for this class was generated from the following files:

• src/OFTCPSocket.h
• src/OFTCPSocket.m