Class generated from inet/transportlayer/contract/sctp/SCTPCommand.msg:110 by nedtool. More...

#include <SCTPCommand_m.h>

Inheritance diagram for inet::SCTPOpenCommand:

Public Member Functions
	SCTPOpenCommand (const char *name=nullptr, short kind=0)

	SCTPOpenCommand (const SCTPOpenCommand &other)

virtual	~SCTPOpenCommand ()

SCTPOpenCommand &	operator= (const SCTPOpenCommand &other)

virtual SCTPOpenCommand *	dup () const override

virtual void	parsimPack (omnetpp::cCommBuffer *b) const override

virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override

virtual AddressVector &	getLocalAddresses ()

virtual const AddressVector &	getLocalAddresses () const

virtual void	setLocalAddresses (const AddressVector &localAddresses)

virtual AddressVector &	getRemoteAddresses ()

virtual const AddressVector &	getRemoteAddresses () const

virtual void	setRemoteAddresses (const AddressVector &remoteAddresses)

virtual bool	getFork () const

virtual void	setFork (bool fork)

virtual const char *	getQueueClass () const

virtual void	setQueueClass (const char *queueClass)

virtual const char *	getSctpAlgorithmClass () const

virtual void	setSctpAlgorithmClass (const char *sctpAlgorithmClass)

virtual uint32_t	getInboundStreams () const

virtual void	setInboundStreams (uint32_t inboundStreams)

virtual uint32_t	getOutboundStreams () const

virtual void	setOutboundStreams (uint32_t outboundStreams)

virtual bool	getStreamReset () const

virtual void	setStreamReset (bool streamReset)

virtual bool	getAppLimited () const

virtual void	setAppLimited (bool appLimited)

virtual int	getPrMethod () const

virtual void	setPrMethod (int prMethod)

virtual uint32_t	getNumRequests () const

virtual void	setNumRequests (uint32_t numRequests)

virtual uint32_t	getMessagesToPush () const

virtual void	setMessagesToPush (uint32_t messagesToPush)

Public Member Functions inherited from inet::SCTPCommand
	SCTPCommand (const char *name=nullptr, short kind=0)

	SCTPCommand (const SCTPCommand &other)

virtual	~SCTPCommand ()

SCTPCommand &	operator= (const SCTPCommand &other)

virtual int	getAssocId () const

virtual void	setAssocId (int assocId)

virtual int	getSid () const

virtual void	setSid (int sid)

virtual int	getNumMsgs () const

virtual void	setNumMsgs (int numMsgs)

virtual int	getSsn () const

virtual void	setSsn (int ssn)

virtual unsigned short	getSendUnordered () const

virtual void	setSendUnordered (unsigned short sendUnordered)

virtual double	getPrValue () const

virtual void	setPrValue (double prValue)

virtual L3Address &	getLocalAddr ()

virtual const L3Address &	getLocalAddr () const

virtual void	setLocalAddr (const L3Address &localAddr)

virtual L3Address &	getRemoteAddr ()

virtual const L3Address &	getRemoteAddr () const

virtual void	setRemoteAddr (const L3Address &remoteAddr)

virtual int	getLocalPort () const

virtual void	setLocalPort (int localPort)

virtual int	getRemotePort () const

virtual void	setRemotePort (int remotePort)

virtual int	getGate () const

virtual void	setGate (int gate)

virtual int	getFd () const

virtual void	setFd (int fd)

Protected Member Functions
bool	operator== (const SCTPOpenCommand &)

Protected Member Functions inherited from inet::SCTPCommand
bool	operator== (const SCTPCommand &)

Protected Attributes
AddressVector	localAddresses

AddressVector	remoteAddresses

bool	fork

::omnetpp::opp_string	queueClass

::omnetpp::opp_string	sctpAlgorithmClass

uint32_t	inboundStreams

uint32_t	outboundStreams

bool	streamReset

bool	appLimited

int	prMethod

uint32_t	numRequests

uint32_t	messagesToPush

Protected Attributes inherited from inet::SCTPCommand
int	assocId

int	sid

int	numMsgs

int	ssn

unsigned short	sendUnordered

double	prValue

L3Address	localAddr

L3Address	remoteAddr

int	localPort

int	remotePort

int	gate

int	fd

Private Member Functions
void	copy (const SCTPOpenCommand &other)

Detailed Description

Class generated from inet/transportlayer/contract/sctp/SCTPCommand.msg:110 by nedtool.

//
// Control info to be used for active or passive ~SCTP open.
//
// localAddr, remoteAddr, localPort, remotePort should be self-explanatory.
// localAddr is optional because ~SCTP can learn it from IP when a packet
// is received from the peer; localPort is optional because ~SCTP supports
// ephemeral ports.
//
// The sendQueueClass, receiveQueueClass and sctpAlgorithmClass fields
// allow per-connection ~SCTP configuration. These fields may contain
// names of messagees submessageed from SCTPSendQueue, SCTPReceiveQueue
// and SCTPAlgorithm, respectively. If not set, module parameters with
// similar names are used.
//
// The fork parameter is used with passive open, and controls what happens
// when an incoming connection is received. With fork=true, it emulates
// the Unix accept(2) syscall semantics: a new connection structure
// is created for the connection (with a new connId, see in ~SCTPCommand),
// and the connection structure with the old connId remains listening.
// With fork=false, all the above does not happen: the first connection
// is accepted (with the original connId), and further incoming connections
// will be refused by ~SCTP by sending an RST segment.
//
// @see ~SctpCommandCode, ~SCTP
//
message SCTPOpenCommand extends SCTPCommand
{
    AddressVector localAddresses;
    AddressVector remoteAddresses;
    bool fork = false;               // used only for passive open
    string queueClass = "SCTPQueue"; // may be left empty
    string sctpAlgorithmClass;       // may be left empty
    uint32 inboundStreams;
    uint32 outboundStreams;
    bool streamReset;
    bool appLimited;
    int prMethod;
    uint32 numRequests;
    uint32 messagesToPush;
}

Constructor & Destructor Documentation

inet::SCTPOpenCommand::SCTPOpenCommand	(	const char *	name = `nullptr`,
		short	kind = `0`
	)

inet::SCTPOpenCommand::SCTPOpenCommand ( const SCTPOpenCommand & other )

virtual inet::SCTPOpenCommand::~SCTPOpenCommand ( )

virtual

Member Function Documentation

void inet::SCTPOpenCommand::copy ( const SCTPOpenCommand & other )

private

virtual SCTPOpenCommand* inet::SCTPOpenCommand::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::SCTPCommand.

273 {return new SCTPOpenCommand(*this);}

inet::SCTPOpenCommand::SCTPOpenCommand

SCTPOpenCommand(const char *name=nullptr, short kind=0)

virtual bool inet::SCTPOpenCommand::getAppLimited ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE().

virtual bool inet::SCTPOpenCommand::getFork ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual uint32_t inet::SCTPOpenCommand::getInboundStreams ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::initAssociation(), and inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual AddressVector& inet::SCTPOpenCommand::getLocalAddresses ( )

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE(), and inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual const AddressVector& inet::SCTPOpenCommand::getLocalAddresses ( ) const

inlinevirtual

Referenced by getLocalAddresses().

279 {return const_cast<SCTPOpenCommand*>(this)->getLocalAddresses();}

inet::SCTPOpenCommand::SCTPOpenCommand

SCTPOpenCommand(const char *name=nullptr, short kind=0)

inet::SCTPOpenCommand::getLocalAddresses

virtual AddressVector & getLocalAddresses()

virtual uint32_t inet::SCTPOpenCommand::getMessagesToPush ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual uint32_t inet::SCTPOpenCommand::getNumRequests ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE(), and inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual uint32_t inet::SCTPOpenCommand::getOutboundStreams ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::initAssociation(), and inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

virtual int inet::SCTPOpenCommand::getPrMethod ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE().

virtual const char* inet::SCTPOpenCommand::getQueueClass ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::initAssociation().

virtual AddressVector& inet::SCTPOpenCommand::getRemoteAddresses ( )

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE().

virtual const AddressVector& inet::SCTPOpenCommand::getRemoteAddresses ( ) const

inlinevirtual

Referenced by getRemoteAddresses().

282 {return const_cast<SCTPOpenCommand*>(this)->getRemoteAddresses();}

inet::SCTPOpenCommand::SCTPOpenCommand

SCTPOpenCommand(const char *name=nullptr, short kind=0)

inet::SCTPOpenCommand::getRemoteAddresses

virtual AddressVector & getRemoteAddresses()

virtual const char* inet::SCTPOpenCommand::getSctpAlgorithmClass ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::initAssociation().

virtual bool inet::SCTPOpenCommand::getStreamReset ( ) const

virtual

Referenced by inet::sctp::SCTPAssociation::process_ASSOCIATE(), and inet::sctp::SCTPAssociation::process_OPEN_PASSIVE().

SCTPOpenCommand& inet::SCTPOpenCommand::operator= ( const SCTPOpenCommand & other )

bool inet::SCTPOpenCommand::operator== ( const SCTPOpenCommand & )

protected

virtual void inet::SCTPOpenCommand::parsimPack ( omnetpp::cCommBuffer * b ) const

overridevirtual

Reimplemented from inet::SCTPCommand.

Referenced by inet::doParsimPacking().

virtual void inet::SCTPOpenCommand::parsimUnpack ( omnetpp::cCommBuffer * b )

overridevirtual

Reimplemented from inet::SCTPCommand.

Referenced by inet::doParsimUnpacking().

virtual void inet::SCTPOpenCommand::setAppLimited ( bool appLimited )

virtual

Referenced by inet::SCTPSocket::connect().

virtual void inet::SCTPOpenCommand::setFork ( bool fork )

virtual

Referenced by inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setInboundStreams ( uint32_t inboundStreams )

virtual

Referenced by inet::SCTPSocket::connect(), and inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setLocalAddresses ( const AddressVector & localAddresses )

virtual

Referenced by inet::SCTPSocket::connect(), and inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setMessagesToPush ( uint32_t messagesToPush )

virtual

Referenced by inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setNumRequests ( uint32_t numRequests )

virtual

Referenced by inet::SCTPSocket::connect(), and inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setOutboundStreams ( uint32_t outboundStreams )

virtual

Referenced by inet::SCTPSocket::connect(), and inet::SCTPSocket::listen().

virtual void inet::SCTPOpenCommand::setPrMethod ( int prMethod )

virtual

Referenced by inet::SCTPSocket::connect().

virtual void inet::SCTPOpenCommand::setQueueClass ( const char * queueClass )

virtual

virtual void inet::SCTPOpenCommand::setRemoteAddresses ( const AddressVector & remoteAddresses )

virtual

virtual void inet::SCTPOpenCommand::setSctpAlgorithmClass ( const char * sctpAlgorithmClass )

virtual

virtual void inet::SCTPOpenCommand::setStreamReset ( bool streamReset )

virtual

Referenced by inet::SCTPSocket::connect(), and inet::SCTPSocket::listen().

Member Data Documentation

bool inet::SCTPOpenCommand::appLimited

protected

bool inet::SCTPOpenCommand::fork

protected

uint32_t inet::SCTPOpenCommand::inboundStreams

protected

AddressVector inet::SCTPOpenCommand::localAddresses

protected

uint32_t inet::SCTPOpenCommand::messagesToPush

protected

uint32_t inet::SCTPOpenCommand::numRequests

protected

uint32_t inet::SCTPOpenCommand::outboundStreams

protected

int inet::SCTPOpenCommand::prMethod

protected

::omnetpp::opp_string inet::SCTPOpenCommand::queueClass

protected

AddressVector inet::SCTPOpenCommand::remoteAddresses

protected

::omnetpp::opp_string inet::SCTPOpenCommand::sctpAlgorithmClass

protected

bool inet::SCTPOpenCommand::streamReset

protected

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

SCTPCommand_m.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation