Panda3D
Public Types | Public Member Functions

OSocketStream Class Reference

A base class for ostreams that write to a (possibly non-blocking) socket. More...

Inheritance diagram for OSocketStream:
ostream SSWriter ios ios_base

List of all members.

Public Types

enum  openmode
enum  seekdir { beg = 0, cur = 1, end = 2 }

Public Member Functions

bool bad ()
 clear ()
 close ()
bool considerFlush ()
 Sends the most recently queued data if enough time has elapsed.
bool eof ()
bool fail ()
bool flush ()
 Sends the most recently queued data now.
bool getCollectTcp ()
 Returns the current setting of "collect-tcp" mode.
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.
int getTcpHeaderSize ()
 Returns the header size for datagrams.
bool good ()
bool isClosed ()
 put (char c)
 seekp (long int off, seekdir dir)
 seekp (unsigned long int pos)
bool sendDatagram (Datagram const dg)
 Transmits the indicated datagram over the socket by prepending it with a little-endian 16-bit byte count.
 setCollectTcp (bool collect_tcp)
 Enables or disables "collect-tcp" mode.
 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.
 setTcpHeaderSize (int tcp_header_size)
 Sets the header size for datagrams.
unsigned long int tellp ()

Detailed Description

A base class for ostreams that write to a (possibly non-blocking) socket.

It adds is_closed(), which can be called after any write operation fails to check whether the socket has been closed, or whether more data may be sent later.


Member Enumeration Documentation

enum openmode [inherited]
enum seekdir [inherited]
Enumerator:
beg 
cur 
end 

Member Function Documentation

bool bad ( ) [inherited]
clear ( ) [inherited]
close ( )

Reimplemented from SSWriter.

bool considerFlush ( ) [inherited]

Sends the most recently queued data if enough time has elapsed.

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

bool eof ( ) [inherited]
bool fail ( ) [inherited]
bool flush ( )

Sends the most recently queued data now.

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

Reimplemented from ostream.

bool getCollectTcp ( ) [inherited]

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

See set_collect_tcp().

double getCollectTcpInterval ( ) [inherited]

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().

int getTcpHeaderSize ( ) [inherited]

Returns the header size for datagrams.

See set_tcp_header_size().

Reimplemented in SocketStream.

bool good ( ) [inherited]
bool isClosed ( )

Reimplemented from SSWriter.

put ( char  c) [inherited]
seekp ( long int  off,
seekdir  dir 
) [inherited]
seekp ( unsigned long int  pos) [inherited]
bool sendDatagram ( Datagram const  dg) [inherited]

Transmits the indicated datagram over the socket by prepending it with a little-endian 16-bit byte count.

Does not return until the data is sent or the connection is closed, even if the socket stream is non-blocking.

setCollectTcp ( bool  collect_tcp) [inherited]

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 ( double  interval) [inherited]

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().

setTcpHeaderSize ( int  tcp_header_size) [inherited]

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.

Reimplemented in SocketStream.

unsigned long int tellp ( ) [inherited]
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties