class SCTPAssociation

SCTP Association. More...

Full nameCoral::SCTPAssociation
Definition#include <sctpassociation.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

This class manages a SCTP assocation. Note: The constructor is protected, a SCTP assocation can be created from an SCTP socket using associate() or accept().

See also: SCTPSocket, SCTPSocket#associate, SCTPSocket#accept

 ~SCTPAssociation ()

~SCTPAssociation

Destructor.

unsigned int  getID ()

getID

[const]

Get internal association ID.

Returns: Association ID.

bool  getLocalAddresses (SocketAddress**& addressArray)

getLocalAddresses

Get local addresses.

Parameters:
addressArrayReference to store NULL-terminated array of local addresses. The addresses are allocated automatically and have to be freed using deleteAddressList().

Returns: true, if addressEntries are sufficient; false otherwise.

See also: SocketAddress#deleteAddressList

bool  getRemoteAddresses (SocketAddress**& addressArray)

getRemoteAddresses

Get remote addresses.

Parameters:
addressArrayReference to store NULL-terminated array of local addresses. The addresses are allocated automatically and have to be freed using deleteAddressList().

Returns: true, if addressEntries are sufficient; false otherwise.

See also: SocketAddress#deleteAddressList

int  receive (char* dataBuffer, size_t& dataBufferSize, char* controlBuffer, size_t& controlBufferSize, int& flags, unsigned short& streamID, unsigned int& protoID)

receive

Parameters:
dataBufferBuffer to store data to.
dataBufferSizeSize of data buffer; this will be overwritten with actual size of data content.
controlBufferBuffer to store control data to.
controlBufferSizeSize of control buffer; this will be overwritten with actual size of control content.
flagsFlags; this will be overwritten with actual reception flags.
streamIDVariable to store stream ID to.
protoIDVariable to store protocol ID to.

Returns: error code (0 for success).

int  send (const char* buffer, const size_t length, const int flags, const unsigned short streamID, const unsigned int protoID)

send

Send data.

Parameters:
bufferData to be sent.
lengthLength of data to be sent.
flagsFlags.
streamIDStream ID.
protoIDProtocol ID.

Returns: error code (0 for success).

void  shutdown ()

shutdown

Shutdown.

void  abort ()

abort

Abort.

 SCTPAssociation (SCTPSocket* socket, const unsigned int associationID, const bool sctpWait)

SCTPAssociation

[protected]