Panda3D
Public Member Functions | Static Public Member Functions | List of all members
SocketTCP Class Reference

Base functionality for a TCP connected socket This class is pretty useless by itself but it does hide some of the platform differences from machine to machine. More...

Inheritance diagram for SocketTCP:
SocketIP TypedObject MemoryBase BufferedDatagramConnection

Public Member Functions

 __init__ ()
 
 __init__ (SOCKET)
 Function name : Socket_TCP::Socket_TCP. More...
 
bool ActiveOpen (const SocketAddress theaddress, bool setdelay)
 Function name : ActiveOpen This function will try and set the socket up for active open to a specified address and port provided by the input parameter. More...
 
bool ActiveOpenNonBlocking (const SocketAddress theaddress)
 Function name : ActiveOpenNonBlocking This function will try and set the socket up for active open to a specified address and port provided by the input parameter (non-blocking version) More...
 
int DontLinger ()
 Function name : Socket_TCP::DontLinger Turn off the linger flag. The socket will quickly release buffered items and free up OS resources. You may lose a stream if you use this flag and do not negotiate the close at the application layer. More...
 
bool ErrorIsWouldBlocking (int err)
 
str RecvData (int max_len)
 Function name : Socket_TCP::RecvData Read the data from the connection. More...
 
int SendData (str str)
 
int SetLinger (int interval_seconds)
 Function name : SetLinger will control the behavior of SO_LINGER for a TCP socket. More...
 
int SetNoDelay (bool flag)
 Function name : SetNoDelay Disable Nagle algorithm. Don't delay send to coalesce packets. More...
 
int SetSendBufferSize (int insize)
 Function name : SetSendBufferSize Just like it sounds. Sets a buffered socket recv buffer size. This function does not refuse ranges outside hard-coded OS limits. More...
 
bool ShutdownSend ()
 
- Public Member Functions inherited from SocketIP
 __init__ ()
 Function name : Socket_IP::Socket_IP Def Constructor. More...
 
 __init__ (SOCKET in)
 Function name : Socket_IP::SetSocket Assigns an existing socket to this class. More...
 
bool Active ()
 Function name : Socket_IP::Active Ask if the socket is open (allocated) More...
 
 Close ()
 Function name : Socket_IP::Close closes a socket if it is open (allocated) More...
 
SocketAddress GetPeerName ()
 Function name : Socket_IP::GetPeerName Wrapper on berkly getpeername... More...
 
SOCKET GetSocket ()
 Function name : Socket_IP::GetSocket Gets the base socket type. More...
 
SOCKET GetSocket ()
 Function name : Socket_IP::GetSocket Get The RAW file id of the socket. More...
 
int SetBlocking ()
 Function name : Socket_IP::SetBlocking Set the socket to block on subsequent calls to socket functions that address this socket. More...
 
int SetNonBlocking ()
 Function name : SetNonBlocking this function will throw a socket into non-blocking mode. More...
 
int SetRecvBufferSize (int size)
 Function name : Socket_IP::SetRecvBufferSize Ok it sets the recv buffer size for both tcp and UDP. More...
 
bool SetReuseAddress (bool flag)
 Function name : SetReuseAddress Informs a socket to reuse IP address as needed. More...
 
 SetSocket (SOCKET ins)
 Function name : Socket_IP::SetSocket Assigns an existing socket to this class. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from SocketIP
static TypeHandle getClassType ()
 
static int GetLastError ()
 Function name : Socket_IP::GetLastError gets the last errcode from a socket operation. More...
 
static int InitNetworkDriver ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 

Detailed Description

Base functionality for a TCP connected socket This class is pretty useless by itself but it does hide some of the platform differences from machine to machine.

Member Function Documentation

◆ __init__() [1/2]

__init__ ( )

◆ __init__() [2/2]

__init__ ( SOCKET  )

Function name : Socket_TCP::Socket_TCP.

◆ ActiveOpen()

bool ActiveOpen ( const SocketAddress  theaddress,
bool  setdelay 
)

Function name : ActiveOpen This function will try and set the socket up for active open to a specified address and port provided by the input parameter.

◆ ActiveOpenNonBlocking()

bool ActiveOpenNonBlocking ( const SocketAddress  theaddress)

Function name : ActiveOpenNonBlocking This function will try and set the socket up for active open to a specified address and port provided by the input parameter (non-blocking version)

◆ DontLinger()

int DontLinger ( )

Function name : Socket_TCP::DontLinger Turn off the linger flag. The socket will quickly release buffered items and free up OS resources. You may lose a stream if you use this flag and do not negotiate the close at the application layer.

◆ ErrorIsWouldBlocking()

bool ErrorIsWouldBlocking ( int  err)

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ RecvData()

str RecvData ( int  max_len)

Function name : Socket_TCP::RecvData Read the data from the connection.

Return type : int

  • if error 0 if socket closed for read or length is 0
  • bytes read ( May be smaller than requested)

◆ SendData()

int SendData ( str  str)

◆ SetLinger()

int SetLinger ( int  interval_seconds)

Function name : SetLinger will control the behavior of SO_LINGER for a TCP socket.

◆ SetNoDelay()

int SetNoDelay ( bool  flag)

Function name : SetNoDelay Disable Nagle algorithm. Don't delay send to coalesce packets.

◆ SetSendBufferSize()

int SetSendBufferSize ( int  insize)

Function name : SetSendBufferSize Just like it sounds. Sets a buffered socket recv buffer size. This function does not refuse ranges outside hard-coded OS limits.

◆ ShutdownSend()

bool ShutdownSend ( )