Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
TcpProcess Class Reference

TcpProcess handles and manipulates the TCP process. More...

Inheritance diagram for TcpProcess:
Process

Public Member Functions

short getUserDefinedMSS ()
 Returns the maximum segment size value. More...
 
void setUserDefinedMSS (short)
 Sets the maximum segment size value. More...
 
int getUserDefinedWindowSize ()
 Returns the window size. More...
 
bool isNagleEnabled ()
 Returns true if Nagle's algorithm is enabled, otherwise false. More...
 
void setNagleEnabled (bool)
 Enables or disables Nagle's algorithm. More...
 
int getNagleWaitingInterval ()
 Returns Nagle's algorithm waiting interval. More...
 
void setNagleWaitingInterval (int)
 Sets Nagle's algorithm waiting interval. More...
 
CustomTcpProcess listen (int, bool)
 Start a tcp connection that listens. More...
 
CustomTcpProcess connect (ip, int, int, int, FrameInstance)
 Start a tcp connection for connecting. More...
 
void deleteCustomProcess (CustomTcpProcess)
 Delete a custom tcp process created for listening or connecting. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

TcpProcess handles and manipulates the TCP process.

Member Function Documentation

◆ connect()

CustomTcpProcess TcpProcess::connect ( ip  ,
int  ,
int  ,
int  ,
FrameInstance   
)

Start a tcp connection for connecting.

Parameters
destinationIp,destinationip address at which the tcp connection will connect to
destinationPort,destinationport number at which the tcp connection will connect to
sourcePort,sourceport number at which the tcp connection is from
timeout,thetime out value at which the tcp connection will stop trying to connect
frameInstance,frameInstanceobject
Returns
CustomTcpProcess, CustomTcpProcess object

◆ deleteCustomProcess()

void TcpProcess::deleteCustomProcess ( CustomTcpProcess  )

Delete a custom tcp process created for listening or connecting.

Parameters
process,CustomTcpProcessobject

◆ getNagleWaitingInterval()

int TcpProcess::getNagleWaitingInterval ( )

Returns Nagle's algorithm waiting interval.

Returns
int, Nagle's algorithm waiting interval.

◆ getUserDefinedMSS()

short TcpProcess::getUserDefinedMSS ( )

Returns the maximum segment size value.

Returns
short, the maximum segment size value.

◆ getUserDefinedWindowSize()

int TcpProcess::getUserDefinedWindowSize ( )

Returns the window size.

Returns
int, the window size.

◆ isNagleEnabled()

bool TcpProcess::isNagleEnabled ( )

Returns true if Nagle's algorithm is enabled, otherwise false.

Returns
bool, true if Nagle's algorithm is enabled, otherwise false.

◆ listen()

CustomTcpProcess TcpProcess::listen ( int  ,
bool   
)

Start a tcp connection that listens.

Parameters
port,portnumber at which the tcp connection listens at
requestNotify,trueif a notify is requested or false if it's not
Returns
CustomTcpProcess, CustomTcpProcess object

◆ setNagleEnabled()

void TcpProcess::setNagleEnabled ( bool  )

Enables or disables Nagle's algorithm.

Parameters
val,trueto enable Nagle's algorithm, false to disable it.

◆ setNagleWaitingInterval()

void TcpProcess::setNagleWaitingInterval ( int  )

Sets Nagle's algorithm waiting interval.

Parameters
interval,Nagle'salgorithm waiting interval.

◆ setUserDefinedMSS()

void TcpProcess::setUserDefinedMSS ( short  )

Sets the maximum segment size value.

Parameters
short,themaximum segment size value.

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