Class generated from inet/transportlayer/contract/tcp/TCPCommand.msg:154 by nedtool. More...

#include <TCPCommand_m.h>

Inheritance diagram for inet::TCPOpenCommand:

Public Member Functions
	TCPOpenCommand ()

	TCPOpenCommand (const TCPOpenCommand &other)

virtual	~TCPOpenCommand ()

TCPOpenCommand &	operator= (const TCPOpenCommand &other)

virtual TCPOpenCommand *	dup () const override

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

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

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 bool	getFork () const

virtual void	setFork (bool fork)

virtual int	getDataTransferMode () const

virtual void	setDataTransferMode (int dataTransferMode)

virtual const char *	getTcpAlgorithmClass () const

virtual void	setTcpAlgorithmClass (const char *tcpAlgorithmClass)

Public Member Functions inherited from inet::TCPCommand
	TCPCommand ()

	TCPCommand (const TCPCommand &other)

virtual	~TCPCommand ()

TCPCommand &	operator= (const TCPCommand &other)

virtual int	getConnId () const

virtual void	setConnId (int connId)

virtual int	getUserId () const

virtual void	setUserId (int userId)

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

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

Protected Attributes
L3Address	localAddr

L3Address	remoteAddr

int	localPort

int	remotePort

bool	fork

int	dataTransferMode

::omnetpp::opp_string	tcpAlgorithmClass

Protected Attributes inherited from inet::TCPCommand
int	connId

int	userId

Private Member Functions
void	copy (const TCPOpenCommand &other)

Detailed Description

Class generated from inet/transportlayer/contract/tcp/TCPCommand.msg:154 by nedtool.

//
// Control info to be used for active or passive TCP open.
//
// localAddr, remoteAddr, localPort, remotePort should be self-explanatory.
// localAddr is optional because TCP can learn it from IP when a packet
// is received from the peer; localPort is optional because TCP supports
// ephemeral ports.
//
// 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 ~TCPCommand),
// 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 TCP by sending an RST segment.
//
// The dataTransferMode and tcpAlgorithmClass fields
// allow per-connection TCP configuration.
// The dataTransferMode field set the
// The tcpAlgorithmClass field may contain name of class subclassed from
// TCPAlgorithm, respectively.
// If not set, module parameters with similar names are used.
//
// @see ~TcpCommandCode, ~ITCP
//
class TCPOpenCommand extends TCPCommand
{
    L3Address localAddr; // may be left empty
    L3Address remoteAddr;// required for active open
    int localPort = -1;       // required for passive open
    int remotePort = -1;      // required for active open
    bool fork = false;        // used only for passive open
    int dataTransferMode @enum(TCPDataTransferMode); // whether to transmit C++ objects, real bytes or just byte counts. See ~TCPDataTransferMode.
    string tcpAlgorithmClass; // TCP congestion control algorithm; leave empty for default
}

Constructor & Destructor Documentation

inet::TCPOpenCommand::TCPOpenCommand ( )

inet::TCPOpenCommand::TCPOpenCommand ( const TCPOpenCommand & other )

virtual inet::TCPOpenCommand::~TCPOpenCommand ( )

virtual

Member Function Documentation

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

private

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

inlineoverridevirtual

Reimplemented from inet::TCPCommand.

324 {return new TCPOpenCommand(*this);}

inet::TCPOpenCommand::TCPOpenCommand

TCPOpenCommand()

virtual int inet::TCPOpenCommand::getDataTransferMode ( ) const

virtual

Referenced by inet::tcp::TCP_NSC::handleAppMessage(), inet::tcp::TCP_lwIP::handleAppMessage(), and inet::tcp::TCPConnection::initConnection().

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

virtual

Referenced by inet::tcp::TCP_NSC::process_OPEN_PASSIVE(), inet::tcp::TCP_lwIP::process_OPEN_PASSIVE(), and inet::tcp::TCPConnection::process_OPEN_PASSIVE().

virtual L3Address& inet::TCPOpenCommand::getLocalAddr ( )

virtual

Referenced by inet::tcp::TCP_NSC::process_OPEN_ACTIVE(), inet::tcp::TCP_lwIP::process_OPEN_ACTIVE(), inet::tcp::TCPConnection::process_OPEN_ACTIVE(), inet::tcp::TCP_NSC::process_OPEN_PASSIVE(), inet::tcp::TCP_lwIP::process_OPEN_PASSIVE(), and inet::tcp::TCPConnection::process_OPEN_PASSIVE().

virtual const L3Address& inet::TCPOpenCommand::getLocalAddr ( ) const

inlinevirtual

Referenced by getLocalAddr().

330 {return const_cast<TCPOpenCommand*>(this)->getLocalAddr();}

inet::TCPOpenCommand::getLocalAddr

virtual L3Address & getLocalAddr()

inet::TCPOpenCommand::TCPOpenCommand

TCPOpenCommand()

virtual int inet::TCPOpenCommand::getLocalPort ( ) const

virtual

Referenced by inet::tcp::TCP_NSC::process_OPEN_ACTIVE(), inet::tcp::TCP_lwIP::process_OPEN_ACTIVE(), inet::tcp::TCPConnection::process_OPEN_ACTIVE(), inet::tcp::TCP_NSC::process_OPEN_PASSIVE(), inet::tcp::TCP_lwIP::process_OPEN_PASSIVE(), and inet::tcp::TCPConnection::process_OPEN_PASSIVE().

virtual L3Address& inet::TCPOpenCommand::getRemoteAddr ( )

virtual

Referenced by inet::tcp::TCP_NSC::process_OPEN_ACTIVE(), inet::tcp::TCP_lwIP::process_OPEN_ACTIVE(), inet::tcp::TCPConnection::process_OPEN_ACTIVE(), and inet::tcp::TCP_NSC::process_OPEN_PASSIVE().

virtual const L3Address& inet::TCPOpenCommand::getRemoteAddr ( ) const

inlinevirtual

Referenced by getRemoteAddr().

333 {return const_cast<TCPOpenCommand*>(this)->getRemoteAddr();}

inet::TCPOpenCommand::TCPOpenCommand

TCPOpenCommand()

inet::TCPOpenCommand::getRemoteAddr

virtual L3Address & getRemoteAddr()

virtual int inet::TCPOpenCommand::getRemotePort ( ) const

virtual

Referenced by inet::tcp::TCP_NSC::process_OPEN_ACTIVE(), inet::tcp::TCP_lwIP::process_OPEN_ACTIVE(), inet::tcp::TCPConnection::process_OPEN_ACTIVE(), and inet::tcp::TCP_NSC::process_OPEN_PASSIVE().

virtual const char* inet::TCPOpenCommand::getTcpAlgorithmClass ( ) const

virtual

Referenced by inet::tcp::TCPConnection::initConnection().

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

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

protected

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

overridevirtual

Reimplemented from inet::TCPCommand.

Referenced by inet::doParsimPacking().

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

overridevirtual

Reimplemented from inet::TCPCommand.

Referenced by inet::doParsimUnpacking().

virtual void inet::TCPOpenCommand::setDataTransferMode ( int dataTransferMode )

virtual

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

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

virtual

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

virtual void inet::TCPOpenCommand::setLocalAddr ( const L3Address & localAddr )

virtual

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

virtual void inet::TCPOpenCommand::setLocalPort ( int localPort )

virtual

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

virtual void inet::TCPOpenCommand::setRemoteAddr ( const L3Address & remoteAddr )

virtual

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

virtual void inet::TCPOpenCommand::setRemotePort ( int remotePort )

virtual

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

virtual void inet::TCPOpenCommand::setTcpAlgorithmClass ( const char * tcpAlgorithmClass )

virtual

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

Member Data Documentation

int inet::TCPOpenCommand::dataTransferMode

protected

bool inet::TCPOpenCommand::fork

protected

L3Address inet::TCPOpenCommand::localAddr

protected

int inet::TCPOpenCommand::localPort

protected

L3Address inet::TCPOpenCommand::remoteAddr

protected

int inet::TCPOpenCommand::remotePort

protected

::omnetpp::opp_string inet::TCPOpenCommand::tcpAlgorithmClass

protected

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

TCPCommand_m.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation