Connection

class Connection

Bases: ReferenceCount

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

Inheritance diagram

explicit Connection(ConnectionManager *manager, Socket_IP *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.

bool consider_flush(void)

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.

bool flush(void)

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

NetAddress get_address(void) const

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

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

ConnectionManager *get_manager(void) const

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

Socket_IP *get_socket(void) const

Returns the internal Socket_IP that defines the connection.

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_ip_time_to_live(int ttl)

Sets IP time-to-live.

void set_ip_type_of_service(int tos)

Sets IP type-of-service and precedence.

void set_keep_alive(bool flag)

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

void set_linger(bool flag, double time)

Socket options. void set_nonblock(bool flag);

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.

void set_max_segment(int size)

Sets the maximum segment size.

void set_no_delay(bool flag)

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

void set_recv_buffer_size(int size)

Sets the size of the receive buffer, in bytes.

void set_reuse_addr(bool flag)

Sets whether local address reuse is allowed.

void set_send_buffer_size(int size)

Sets the size of the send buffer, in bytes.