Association Distribution

o SCTPINSTANCE
This struct stores data of SCTP-instances.
o ASSOCIATION
This struct contains all data of an association.
o AssociationList
Keyed list of associations with the association-ID as key
o sctpInstance
Whenever an external event (ULP-call, socket-event or timer-event) this variable must contain the addressed sctp instance.
o InstanceList
Keyed list of SCTP instances with the instance name as key
o currentAssociation
Whenever an external event (ULP-call, socket-event or timer-event) this variable must contain the addressed association.
o lastFromPath
o sctp_socket
Descriptor of socket used by all associations and SCTP-instances
o compareAssociationIDs
compareAssociationIDs compares the association ID's of two associations and returns 0 if they are equal.
o equalAssociations
equalAssociations compares two associations and returns 0 if they are equal.
o enterAssociation
enterAssociation adds an association to the list.
o retrieveAssociation
retrieveAssociation retrieves a association from the list using the local tag as key.
o retrieveAssociationULP
retrieveAssociationULP retrieves a association from the list using the local tag as key.
o retrieveAssociationByTransportAddress
retrieveAssociation retrieves a association from the list using the transport address as key.
o checkForExistingAssociations
checkForExistingAssociations checks wether a given association is already in the list using the equality condition given by function equalAssociations.
o seizePort
seizePort return a free port number.
o releasePort
releasePort frees a previously used port.
o mdi_deleteAssociation
deleteAssociation removes the association from the list of associations, frees all data allocated for it and <calls moduleprefix>_delete*() function at all modules.
o mdi_receiveMessage
mdi_receiveMessage is the callback function of the SCTP-message distribution.
o sctp_registerInstance
sctp_registerInstance is called to initialize one SCTP-instance.
o sctp_deleteAssociation
This function should be called AFTER an association has indicated a COMMUNICATION_LOST or a SHUTDOWN_COMPLETE, and the upper layer has retrieved all data it is interested in (possibly using the currently not implemented functions sctp_receive_unsent() or sctp_receive_unacked()) it really removes all data belonging to the association, and removes the association instance from the list, on explicit upper layer instruction !
o sctp_associate
This function is called to setup an association.
o sctp_shutdown
sctp_shutdown initiates the shutdown of the specified association.
o sctp_abort
sctp_abort initiates the abort of the specified association.
o sctp_send
sctp_send is used by the ULP to send data chunks.
o sctp_setPrimary
sctp_setPrimary changes the primary path of an association.
o sctp_receive
sctp_receive is called in response to the dataArriveNotification to get the received data.
o sctp_changeHeartBeat
sctp_changeHeartBeat turns the hearbeat on a path of an association on or off, or modifies the interval
o sctp_requestHeartbeat
sctp_requestHeartbeat sends a heartbeat to the given address of an association.
o sctp_getSrttReport
sctp_getSrttReport returns a smoothed RTT value for a path to a given address
o sctp_setFailureThreshold
sctp_setFailureThreshold is currently NOT implemented !
o sctp_getPathStatus
sctp_getPathStatus : IP_TOS support is still missing !
o sctp_setPathStatus
sctp_setPathStatus is currently NOT implemented !
o sctp_setAssocStatus
sctp_setAssocStatus allows for setting a number of association parameters.
o sctp_getAssocStatus
sctp_getAssocStatus is currently NOT implemented !
o sctp_setAssocDefaults
sctp_setAssocDefaults allows for setting a few association default parameters !
o sctp_getAssocDefaults
sctp_getInstanceParams returns a struct with default parameter values !
o sctp_receiveUnsent
sctp_receive_unsent is currently NOT implemented !
o sctp_receiveUnacked
sctp_receive_unacked is currently NOT implemented !
o sctp_getPrimary
sctp_getPrimary is currently NOT implemented !
o mdi_send_message
Used by bundling to send a SCTP-datagramm.
o mdi_dataArriveNotif
indicates new data has arrived from peer (chapter 102) destined for the ULP
o mdi_networkStatusChangeNotif
indicates a change of network status (chapter 102C).
o mdi_sendFailureNotif
indicates a send failure (chapter 102B).
o mdi_shutdownCompleteNotif
indicates that association has been gracefully shut down (chapter 102H).
o mdi_restartNotif
indicates that a restart has occured(chapter 102G).
o mdi_communicationLostNotif
indicates that communication was lost to peer (chapter 102E).
o mdi_communicationUpNotif
indicates that an association is established (chapter 102D).
o mdi_readFlowControl
function to return a pointer to the flow control module of this association
o mdi_readReliableTransfer
function to return a pointer to the reliable transfer-module of this association
o mdi_readRX_control
function to return a pointer to the receiver module of this association
o mdi_readStreamEngine
function to return a pointer to the stream-engine module of this association
o mdi_readPathMan
function to return a pointer to the path management module of this association
o mdi_readBundling
function to return a pointer to the bundling module of this association
o mdi_readSCTP_control
function to return a pointer to the state machine controller of this association
o mdi_readAssociationID
function to read the association id of the current association
o mdi_readTagRemote
function to read the tag that the peer within the current association uses
o mdi_generateLocalTag
generates a random tag value for a new association, but not 0
o mdi_generateStartTSN
generates a random tsn value for a new association (may also be 0)
o *mdi_readLastFromAddress
read the address from which the last datagramm was received (host byte order).
o mdi_readLastFromPath
read the index of the path from which the last DG was received (-1 if no DG was received)
o mdi_readLastFromPort
read the port of the sender of the last received DG (host byte order)
o mdi_readLastDestPort
read the port of the destination of the last received DG (host byte order)
o mdi_writeDestinationAddresses
copies destination addresses from the array passed as parameter to the current association
o mdi_readLocalInStreams
Function that returns the number of incoming streams that this instance is willing to handle !
o mdi_readLocalOutStreams
Function that returns the number of incoming streams that this instance is willing to handle !
o mdi_readLocalAddresses
Copies local addresses of this instance into the array passed as parameter CHECKME : does this function work in all circumstances ?
o mdi_setAssociationData
Each module within SCTP that has timers implements its own timer call back functions.
o mdi_clearAssociationData
Clear the global association data.
o mdi_newAssociation
This function allocates memory for a new association.
o mdi_initAssociation
This is the second function needed to fully create and initialize an association (after mdi_newAssociation()) THe association is created in two steps because data become available at the a-side in two steps
  1. associate
  2. init acknowledgement
At the z-side, with the cookie message all data is available at once.
o mdi_deleteCurrentAssociation
mdi_deleteCurrentAssociation deletes the current association.

Alphabetic index Hierarchy of classes


This page was generated with the help of DOC++.