OFSCTPSocket.h File Reference

import "OFSequencedPacketSocket.h"
import "OFRunLoop.h"

Go to the source code of this file.

Classes
protocol	<OFSCTPSocketDelegate>
class	OFSCTPSocket
	A class which provides methods to create and use SCTP sockets in one-to-one mode. More...

Typedefs
typedef OFConstantString *	OFSCTPMessageInfoKey
	A key for the SCTP message info.
typedef OFDictionary *	OFSCTPMessageInfo
	A dictionary mapping keys of type OFSCTPMessageInfoKey to their values.
typedef void(^	OFSCTPSocketConnectedHandler) (OFSCTPSocket *socket, OFString *host, uint16_t port, id exception)
	A handler which is called when the socket connected.
typedef bool(^	OFSCTPSocketMessageReceivedHandler) (OFSCTPSocket *socket, void *buffer, size_t length, OFSCTPMessageInfo info, id exception)
	A handler which is called when a message has been received.
typedef OFData *(^	OFSCTPSocketDataSentHandler) (OFSCTPSocket *socket, OFData *data, OFSCTPMessageInfo info, id exception)
	A handler which is called when a message has been sent.

Variables
const OFSCTPMessageInfoKey	OFSCTPStreamID
	The SCTP stream ID for which the message was send / received.
const OFSCTPMessageInfoKey	OFSCTPPPID
	The Payload Protocol Identifier for the message.
const OFSCTPMessageInfoKey	OFSCTPUnordered
	Whether the message is send / received out of order.

Typedef Documentation

OFSCTPMessageInfoKey

typedef OFConstantString* OFSCTPMessageInfoKey

A key for the SCTP message info.

Possible values are:

• OFSCTPStreamID
• OFSCTPPPID
• OFSCTPUnordered

OFSCTPSocketConnectedHandler

typedef void(^ OFSCTPSocketConnectedHandler) (OFSCTPSocket *socket, OFString *host, uint16_t port, id exception)

A handler which is called when the socket connected.

Parameters

socket	The socket which connected
host	The host connected to
port	The port on the host connected to
exception	An exception which occurred while connecting the socket or nil on success

OFSCTPSocketDataSentHandler

typedef OFData *(^ OFSCTPSocketDataSentHandler) (OFSCTPSocket *socket, OFData *data, OFSCTPMessageInfo info, id exception)

A handler which is called when a message has been sent.

Parameters

socket	The SCTP socket which sent a message
data	The data which was sent
info	Information about the message, see OFSCTPMessageInfo
exception	An exception which occurred while reading or nil on success

Returns

The data to repeat the send with or nil if it should not repeat

OFSCTPSocketMessageReceivedHandler

typedef bool(^ OFSCTPSocketMessageReceivedHandler) (OFSCTPSocket *socket, void *buffer, size_t length, OFSCTPMessageInfo info, id exception)

A handler which is called when a message has been received.

Parameters

socket	The SCTP socket which received a message
buffer	The buffer the message has been written to
length	The length of the message
info	Information about the message, see OFSCTPMessageInfo
exception	An exception which occurred while receiving or nil on success

Returns

A bool whether the same handler should be used for the next receive

Variable Documentation

OFSCTPPPID

const OFSCTPMessageInfoKey OFSCTPPPID

extern

The Payload Protocol Identifier for the message.

This is an uint32_t wrapped in an OFNumber.

OFSCTPStreamID

const OFSCTPMessageInfoKey OFSCTPStreamID

extern

The SCTP stream ID for which the message was send / received.

This is an uint16_t wrapped in an OFNumber.

OFSCTPUnordered

const OFSCTPMessageInfoKey OFSCTPUnordered

extern

Whether the message is send / received out of order.

Possible values are an OFNumber with either true or false.