Packet SCTPCommand

File: src/inet/transportlayer/contract/sctp/SCTPCommand.msg

Control info for SCTP connections. This message is to be set as control info (see cMessage::setControlInfo()) on all messages exchanged between SCTP and application, in both directions. Some commands and indications (SCTP_C_OPEN_xxx, SCTP_I_STATUS) use submessagees.

connId identifies the connection locally within the application (internally, SCTP uses the (app gate index, connId) pair to identify the socket). connId is to be chosen by the application in the open command.

See also: SctpCommandCode, SctpStatusInd, SCTPOpenCommand, SCTPStatusInfo, SCTPMain

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Known subclasses:

Name	Type	Description
SCTPConnectInfo	message	Sent with message kind SCTP_I_ESTABLISHED, to let the app know about the local and remote IP address and port.
SCTPErrorInfo	message	Currently not in use.
SCTPInfo	message	(no description)
SCTPOpenCommand	message	Control info to be used for active or passive SCTP open.
SCTPPathInfo	message	(no description)
SCTPRcvInfo	message	Control info to be used with the DATA command.
SCTPResetInfo	message	(no description)
SCTPRtoInfo	message	Control info to be used when setsockopt changes RtoInfo.
SCTPSendInfo	message	Control info to be used with the SEND command.
SCTPSendQueueAbated	message	(no description)
SCTPStatusInfo	message	Sent with message kind SCTP_I_STATUS, in response to command SCTP_C_STATUS. For explanation of variables, see RFC 4960 or SCTPStateVariables in SCTPAssociation.h.

Fields:

Name	Type	Description
assocId	int	identifies the socket within the application
sid	int
numMsgs	int
ssn	int
sendUnordered	unsigned short
prValue	double
localAddr	L3Address
remoteAddr	L3Address
localPort	int
remotePort	int
gate	int
fd	int

Source code:

//
// Control info for SCTP connections. This message is to be set as control info
// (see cMessage::setControlInfo()) on all messages exchanged between ~SCTP and
// application, in both directions. Some commands and indications
// (SCTP_C_OPEN_xxx, SCTP_I_STATUS) use submessagees.
//
// connId identifies the connection locally within the application (internally,
// ~SCTP uses the (app gate index, connId) pair to identify the socket).
// connId is to be chosen by the application in the open command.
//
// @see ~SctpCommandCode, ~SctpStatusInd, ~SCTPOpenCommand, ~SCTPStatusInfo, SCTPMain
//
packet SCTPCommand
{
    int assocId = -1;   // identifies the socket within the application
    int sid = -1;
    int numMsgs = 1;
    int ssn = -1;
    unsigned short sendUnordered = false;
    double prValue = 0;
    L3Address localAddr;
    L3Address remoteAddr;
    int localPort = -1;
    int remotePort = -1;
    int gate = -1;
    int fd = -1;
}