# SSWriter¶

class SSWriter

An internal class for writing to a socket stream. This serves as a base class for both OSocketStream and SocketStream; its purpose is to minimize redundant code between them. Do not use it directly.

Inheritance diagram

virtual void close(void) = 0
bool consider_flush(void)

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 flush(void)

Sends the most recently queued data now. This only has meaning if set_collect_tcp() has been set to true.

bool get_collect_tcp(void) const

Returns the current setting of “collect-tcp” mode. See set_collect_tcp().

double get_collect_tcp_interval(void) const

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 get_tcp_header_size(void) const

Returns the header size for datagrams. See set_tcp_header_size().

virtual bool is_closed(void) = 0
bool send_datagram(Datagram const &dg)

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.

void set_collect_tcp(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.

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

void set_tcp_header_size(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.