OFSCTPSocket Class Reference

A class which provides methods to create and use SCTP sockets in one-to-one mode. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFSCTPSocket:

Instance Methods
(void)	- connectToHost:port:
	Connect the OFSCTPSocket to the specified destination.
(void)	- asyncConnectToHost:port:
	Asynchronously connect the OFSCTPSocket to the specified destination.
(void)	- asyncConnectToHost:port:runLoopMode:
	Asynchronously connect the OFSCTPSocket to the specified destination.
(void)	- asyncConnectToHost:port:handler:
	Asynchronously connect the OFSCTPSocket to the specified destination.
(void)	- asyncConnectToHost:port:runLoopMode:handler:
	Asynchronously connect the OFSCTPSocket to the specified destination.
(OFSocketAddress)	- bindToHost:port:
	Bind the socket to the specified host and port.
(size_t)	- receiveIntoBuffer:length:info:
	Receives a message for the specified stream ID and stores it into the specified buffer.
(void)	- asyncReceiveWithInfoIntoBuffer:length:
	Asynchronously receives a message and stores it into the specified buffer.
(void)	- asyncReceiveWithInfoIntoBuffer:length:runLoopMode:
	Asynchronously receives a message and stores it into the specified buffer.
(void)	- asyncReceiveWithInfoIntoBuffer:length:handler:
	Asynchronously receives a message and stores it into the specified buffer.
(void)	- asyncReceiveWithInfoIntoBuffer:length:runLoopMode:handler:
	Asynchronously receives a message and stores it into the specified buffer.
(void)	- sendBuffer:length:info:
	Sends the specified message on the specified stream.
(void)	- asyncSendData:info:
	Asynchronously sends the specified message on the specified stream.
(void)	- asyncSendData:info:runLoopMode:
	Asynchronously sends the specified message on the specified stream.
(void)	- asyncSendData:info:handler:
	Asynchronously sends the specified message on the specified stream.
(void)	- asyncSendData:info:runLoopMode:handler:
	Asynchronously sends the specified message on the specified stream.
Instance Methods inherited from OFSequencedPacketSocket
(size_t)	- receiveIntoBuffer:length:
	Receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:runLoopMode:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:block:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:handler:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:runLoopMode:block:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- asyncReceiveIntoBuffer:length:runLoopMode:handler:
	Asynchronously receives a packet and stores it into the specified buffer.
(void)	- sendBuffer:length:
	Sends the specified packet.
(void)	- asyncSendData:
	Asynchronously sends the specified packet.
(void)	- asyncSendData:runLoopMode:
	Asynchronously sends the specified packet.
(void)	- asyncSendData:block:
	Asynchronously sends the specified packet.
(void)	- asyncSendData:handler:
	Asynchronously sends the specified packet.
(void)	- asyncSendData:runLoopMode:block:
	Asynchronously sends the specified packet.
(void)	- asyncSendData:runLoopMode:handler:
	Asynchronously sends the specified packet.
(void)	- listenWithBacklog:
	Listen on the socket.
(void)	- listen
	Listen on the socket.
(instancetype)	- accept
	Accept an incoming connection.
(void)	- asyncAccept
	Asynchronously accept an incoming connection.
(void)	- asyncAcceptWithRunLoopMode:
	Asynchronously accept an incoming connection.
(void)	- asyncAcceptWithBlock:
	Asynchronously accept an incoming connection.
(void)	- asyncAcceptWithHandler:
	Asynchronously accept an incoming connection.
(void)	- asyncAcceptWithRunLoopMode:block:
	Asynchronously accept an incoming connection.
(void)	- asyncAcceptWithRunLoopMode:handler:
	Asynchronously accept an incoming connection.
(void)	- cancelAsyncRequests
	Cancels all pending asynchronous requests on the socket.
(void)	- releaseSocketFromCurrentThread
	Releases the socket from the current thread.
(void)	- obtainSocketForCurrentThread
	Obtains the socket for the current thread.
(void)	- close
	Closes the socket so that it can neither receive nor send any more datagrams.
Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.
(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.
(void)	- dealloc
	Deallocates the object.
(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.
(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.
(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.
(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.
(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.
(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.
(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.
(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.
(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.
(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.
(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.
(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.
(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.
Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.
(unsigned int)	- retainCount
	Returns the retain count.
(bool)	- isProxy
	Returns whether the object is a proxy object.
(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.
(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.
(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.
(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(nullable id)	- performSelector:
	Performs the specified selector.
(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.
(bool)	- isEqual:
	Checks two objects for equality.
(instancetype)	- retain
	Increases the retain count.
(void)	- release
	Decreases the retain count.
(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.
(instancetype)	- self
	Returns the receiver.
(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.
(bool)	- retainWeakReference
	Retain a weak reference to this object.
Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.

Properties
bool	canDelaySendingMessages
	Whether sending messages can be delayed. Setting this to NO sets SCTP_NODELAY on the socket.
id< OFSCTPSocketDelegate >	delegate
	The delegate for asynchronous operations on the socket.
Properties inherited from OFSequencedPacketSocket
bool	canBlock
	Whether the socket can block.
bool	listening
	Whether the socket is a listening socket.
const OFSocketAddress *	remoteAddress
	The remote address.
id< OFSequencedPacketSocketDelegate >	delegate
	The delegate for asynchronous operations on the socket.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.
Properties inherited from <OFReadyForReadingObserving>
int	fileDescriptorForReading
	The file descriptor for reading that should be checked by the OFKernelEventObserver.
Properties inherited from <OFReadyForWritingObserving>
int	fileDescriptorForWriting
	The file descriptor for writing that should be checked by the OFKernelEventObserver.

Additional Inherited Members
Class Methods inherited from OFSequencedPacketSocket
(instancetype)	+ socket
	Returns a new, autoreleased OFSequencedPacketSocket.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ unload
	A method which is called when the class is unloaded from the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(Class)	+ class
	Returns the class.
(OFString *)	+ className
	Returns the name of the class as a string.
(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.
(nullable Class)	+ superclass
	Returns the superclass of the class.
(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.
(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.
(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.
(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.
(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.
(id)	+ copy
	Returns the class.
Protected Attributes inherited from OFSequencedPacketSocket

Detailed Description

A class which provides methods to create and use SCTP sockets in one-to-one mode.

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

asyncConnectToHost:port:

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

Asynchronously connect the OFSCTPSocket to the specified destination.

Parameters

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

asyncConnectToHost:port:handler:

- (void) asyncConnectToHost:		(OFString *)	host
port:		(uint16_t)	port
handler:		(OFSCTPSocketConnectedHandler)	handler

Asynchronously connect the OFSCTPSocket to the specified destination.

Parameters

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

asyncConnectToHost:port:runLoopMode:

- (void) asyncConnectToHost:		(OFString *)	host
port:		(uint16_t)	port
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously connect the OFSCTPSocket to the specified destination.

Parameters

host	The host to connect to
port	The port on the host to connect to
runLoopMode	The run loop mode in which to perform the async connect

asyncConnectToHost:port:runLoopMode:handler:

- (void) asyncConnectToHost:		(OFString *)	host
port:		(uint16_t)	port
runLoopMode:		(OFRunLoopMode)	runLoopMode
handler:		(OFSCTPSocketConnectedHandler)	handler

Asynchronously connect the OFSCTPSocket to the specified destination.

Parameters

host	The host to connect to
port	The port on the host to connect to
runLoopMode	The run loop mode in which to perform the async connect
handler	The handler to execute once the connection has been established

asyncReceiveWithInfoIntoBuffer:length:

- (void) asyncReceiveWithInfoIntoBuffer:		(void *)	buffer
length:		(size_t)	length

Asynchronously receives a message and stores it into the specified buffer.

If the buffer is too small, the message is truncated.

Parameters

buffer	The buffer to write the message to
length	The length of the buffer

asyncReceiveWithInfoIntoBuffer:length:handler:

- (void) asyncReceiveWithInfoIntoBuffer:		(void *)	buffer
length:		(size_t)	length
handler:		(OFSCTPSocketMessageReceivedHandler)	handler

Asynchronously receives a message and stores it into the specified buffer.

If the buffer is too small, the message is truncated.

Parameters

buffer	The buffer to write the message to
length	The length of the buffer
handler	The handler to call when the message has been received. If the handler returns true, it will be called again with the same buffer and maximum length when more messages have been received. If you want the next method in the queue to handle the message received next, you need to return false from the method.

asyncReceiveWithInfoIntoBuffer:length:runLoopMode:

- (void) asyncReceiveWithInfoIntoBuffer:		(void *)	buffer
length:		(size_t)	length
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously receives a message and stores it into the specified buffer.

If the buffer is too small, the message is truncated.

Parameters

buffer	The buffer to write the message to
length	The length of the buffer
runLoopMode	The run loop mode in which to perform the asynchronous receive

asyncReceiveWithInfoIntoBuffer:length:runLoopMode:handler:

- (void) asyncReceiveWithInfoIntoBuffer:		(void *)	buffer
length:		(size_t)	length
runLoopMode:		(OFRunLoopMode)	runLoopMode
handler:		(OFSCTPSocketMessageReceivedHandler)	handler

Asynchronously receives a message and stores it into the specified buffer.

If the buffer is too small, the message is truncated.

Parameters

buffer	The buffer to write the message to
length	The length of the buffer
runLoopMode	The run loop mode in which to perform the asynchronous receive
handler	The handler to call when the message has been received. If the handler returns true, it will be called again with the same buffer and maximum length when more messages have been received. If you want the next method in the queue to handle the message received next, you need to return false from the method.

asyncSendData:info:

- (void) asyncSendData:		(OFData *)	data
info:		(nullable OFSCTPMessageInfo)	info

Asynchronously sends the specified message on the specified stream.

Parameters

data	The data to send as a message
info	Information about the message, see OFSCTPMessageInfo

asyncSendData:info:handler:

- (void) asyncSendData:		(OFData *)	data
info:		(nullable OFSCTPMessageInfo)	info
handler:		(OFSCTPSocketDataSentHandler)	handler

Asynchronously sends the specified message on the specified stream.

Parameters

data	The data to send as a message
info	Information about the message, see OFSCTPMessageInfo
handler	The handler to call when the message has been sent. It should return the data for the next send with the same callback or nil if it should not repeat.

asyncSendData:info:runLoopMode:

- (void) asyncSendData:		(OFData *)	data
info:		(nullable OFSCTPMessageInfo)	info
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously sends the specified message on the specified stream.

Parameters

data	The data to send as a message
info	Information about the message, see OFSCTPMessageInfo
runLoopMode	The run loop mode in which to perform the asynchronous send

asyncSendData:info:runLoopMode:handler:

- (void) asyncSendData:		(OFData *)	data
info:		(nullable OFSCTPMessageInfo)	info
runLoopMode:		(OFRunLoopMode)	runLoopMode
handler:		(OFSCTPSocketDataSentHandler)	handler

Asynchronously sends the specified message on the specified stream.

Parameters

data	The data to send as a message
info	Information about the message, see OFSCTPMessageInfo
runLoopMode	The run loop mode in which to perform the asynchronous send
handler	The handler to call when the message has been sent. It should return the data for the next send with the same callback or nil if it should not repeat.

bindToHost:port:

- (OFSocketAddress) 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 address the socket was bound to

Exceptions

OFBindIPSocketFailedException	Binding failed
OFAlreadyOpenException	The socket is already connected or bound

connectToHost:port:

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

Connect the OFSCTPSocket to the specified destination.

Parameters

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

Exceptions

OFConnectIPSocketFailedException	Connecting failed
OFAlreadyOpenException	The socket is already connected or bound

receiveIntoBuffer:length:info:

- (size_t) receiveIntoBuffer:		(void *)	buffer
length:		(size_t)	length
info:		(__autoreleasing OFSCTPMessageInfo *)	info

Receives a message for the specified stream ID and stores it into the specified buffer.

If the buffer is too small, the message is truncated.

Parameters

buffer	The buffer to write the message to
length	The length of the buffer
info	Information about the message, see OFSCTPMessageInfo

Returns

The length of the received message

Exceptions

OFReadFailedException	Receiving failed
OFNotOpenException	The socket is not open

sendBuffer:length:info:

- (void) sendBuffer:		(const void *)	buffer
length:		(size_t)	length
info:		(nullable OFSCTPMessageInfo)	info

Sends the specified message on the specified stream.

Parameters

buffer	The buffer to send as a message
length	The length of the buffer
info	Information about the message, see OFSCTPMessageInfo

Exceptions

OFWriteFailedException	Sending failed
OFNotOpenException	The socket is not open

Property Documentation

canDelaySendingMessages

- (bool) canDelaySendingMessages

readwritenonatomicassign

Whether sending messages can be delayed. Setting this to NO sets SCTP_NODELAY on the socket.

Exceptions

OFGetOptionFailedException	The option could not be retrieved
OFSetOptionFailedException	The option could not be set

delegate

- (id<OFSCTPSocketDelegate>) delegate

readwriteatomic

The delegate for asynchronous operations on the socket.

Note

The delegate is retained for as long as asynchronous operations are still ongoing.

---

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

• src/OFSCTPSocket.h
• src/OFSCTPSocket.m