Panda3D
Public Member Functions | List of all members
Connection Class Reference

Represents a single TCP or UDP socket for input or output. More...

Inheritance diagram for Connection:
ReferenceCount

Public Member Functions

 __init__ (ConnectionManager manager, SocketIP socket)
 Creates a connection. More...
 
bool considerFlush ()
 Sends the most recently queued TCP datagram(s) if enough time has elapsed. More...
 
bool flush ()
 Sends the most recently queued TCP datagram(s) now. More...
 
NetAddress getAddress ()
 Returns the address bound to this connection, if it is a TCP connection. More...
 
bool getCollectTcp ()
 Returns the current setting of "collect-tcp" mode. More...
 
double getCollectTcpInterval ()
 Returns the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once. More...
 
ConnectionManager getManager ()
 Returns a pointer to the ConnectionManager object that serves this connection. More...
 
SocketIP getSocket ()
 Returns the internal Socket_IP that defines the connection. More...
 
 setCollectTcp (bool collect_tcp)
 Enables or disables "collect-tcp" mode. More...
 
 setCollectTcpInterval (double interval)
 Specifies the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once. More...
 
 setIpTimeToLive (int ttl)
 Sets IP time-to-live. More...
 
 setIpTypeOfService (int tos)
 Sets IP type-of-service and precedence. More...
 
 setKeepAlive (bool flag)
 Sets whether the connection is periodically tested to see if it is still alive. More...
 
 setLinger (bool flag, double time)
 Sets the time to linger on close if data is present. More...
 
 setMaxSegment (int size)
 Sets the maximum segment size. More...
 
 setNoDelay (bool flag)
 If flag is true, this disables the Nagle algorithm, and prevents delaying of send to coalesce packets. More...
 
 setRecvBufferSize (int size)
 Sets the size of the receive buffer, in bytes. More...
 
 setReuseAddr (bool flag)
 Sets whether local address reuse is allowed. More...
 
 setSendBufferSize (int size)
 Sets the size of the send buffer, in bytes. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Detailed Description

Represents a single TCP or UDP socket for input or output.

Member Function Documentation

◆ __init__()

__init__ ( ConnectionManager  manager,
SocketIP  socket 
)

Creates a connection.

Normally this constructor should not be used directly by user code; use one of the methods in ConnectionManager to make a new connection.

◆ considerFlush()

bool considerFlush ( )

Sends the most recently queued TCP datagram(s) if enough time has elapsed.

This only has meaning if set_collect_tcp() has been set to true.

◆ flush()

bool flush ( )

Sends the most recently queued TCP datagram(s) now.

This only has meaning if set_collect_tcp() has been set to true.

◆ getAddress()

NetAddress getAddress ( )

Returns the address bound to this connection, if it is a TCP connection.

◆ getCollectTcp()

bool getCollectTcp ( )

Returns the current setting of "collect-tcp" mode.

See set_collect_tcp().

◆ getCollectTcpInterval()

double getCollectTcpInterval ( )

Returns the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once.

This only has meaning if "collect-tcp" mode is enabled; see set_collect_tcp().

◆ getManager()

ConnectionManager getManager ( )

Returns a pointer to the ConnectionManager object that serves this connection.

◆ getSocket()

SocketIP getSocket ( )

Returns the internal Socket_IP that defines the connection.

◆ setCollectTcp()

setCollectTcp ( bool  collect_tcp)

Enables or disables "collect-tcp" mode.

In this mode, individual TCP packets are not sent immediately, but rather they are collected together and accumulated to be sent periodically as one larger TCP packet. This cuts down on overhead from the TCP/IP protocol, especially if many small packets need to be sent on the same connection, but it introduces additional latency (since packets must be held before they can be sent).

See set_collect_tcp_interval() to specify the interval of time for which to hold packets before sending them.

If you enable this mode, you may also need to periodically call consider_flush() to flush the queue if no packets have been sent recently.

◆ setCollectTcpInterval()

setCollectTcpInterval ( double  interval)

Specifies the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once.

This only has meaning if "collect-tcp" mode is enabled; see set_collect_tcp().

◆ setIpTimeToLive()

setIpTimeToLive ( int  ttl)

Sets IP time-to-live.

◆ setIpTypeOfService()

setIpTypeOfService ( int  tos)

Sets IP type-of-service and precedence.

◆ setKeepAlive()

setKeepAlive ( bool  flag)

Sets whether the connection is periodically tested to see if it is still alive.

◆ setLinger()

setLinger ( bool  flag,
double  time 
)

Sets the time to linger on close if data is present.

If flag is false, when you close a socket with data available the system attempts to deliver the data to the peer (the default behavior). If flag is false but time is zero, the system discards any undelivered data when you close the socket. If flag is false but time is nonzero, the system waits up to time seconds to deliver the data.

◆ setMaxSegment()

setMaxSegment ( int  size)

Sets the maximum segment size.

◆ setNoDelay()

setNoDelay ( bool  flag)

If flag is true, this disables the Nagle algorithm, and prevents delaying of send to coalesce packets.

◆ setRecvBufferSize()

setRecvBufferSize ( int  size)

Sets the size of the receive buffer, in bytes.

◆ setReuseAddr()

setReuseAddr ( bool  flag)

Sets whether local address reuse is allowed.

◆ setSendBufferSize()

setSendBufferSize ( int  size)

Sets the size of the send buffer, in bytes.