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

An internal class for reading from a socket stream. More...

Inheritance diagram for SSReader:
ISocketStream SocketStream

Public Member Functions

 close ()
 
int getTcpHeaderSize ()
 Returns the header size for datagrams. More...
 
bool isClosed ()
 
bool receiveDatagram (Datagram dg)
 Receives a datagram over the socket by expecting a little-endian 16-bit byte count as a prefix. More...
 
 setTcpHeaderSize (int tcp_header_size)
 Sets the header size for datagrams. More...
 

Detailed Description

An internal class for reading from a socket stream.

This serves as a base class for both ISocketStream and SocketStream; its purpose is to minimize redundant code between them. Do not use it directly.

Member Function Documentation

◆ close()

close ( )

◆ getTcpHeaderSize()

int getTcpHeaderSize ( )

Returns the header size for datagrams.

See set_tcp_header_size().

◆ isClosed()

bool isClosed ( )

◆ receiveDatagram()

bool receiveDatagram ( Datagram  dg)

Receives a datagram over the socket by expecting a little-endian 16-bit byte count as a prefix.

If the socket stream is non-blocking, may return false if the data is not available; otherwise, returns false only if the socket closes.

◆ setTcpHeaderSize()

setTcpHeaderSize ( int  tcp_header_size)

Sets the header size for datagrams.

At the present, legal values for this are 0, 2, or 4; this specifies the number of bytes to use encode the datagram length at the start of each TCP datagram. Sender and receiver must independently agree on this.