UCommon
Public Member Functions
ost::DCCPSocket Class Reference

DCCP sockets are used for stream based connected sessions between two sockets. More...

#include <dccp.h>

Inherits ost::Socket.

Public Member Functions

size_t available () const
 Return number of bytes to be read.
 
void connect (const IPV4Host &host, tpport_t port, timeout_t timeout=0)
 Create a DCCP client connection to a DCCP socket (on a remote machine). More...
 
void connect (const IPV6Host &host, tpport_t port, timeout_t timeout=0)
 
void connect (const char *name)
 Connect to a named client.
 
 DCCPSocket (const IPV4Address &bind, tpport_t port, unsigned backlog=5)
 A DCCP "server" is created as a DCCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests. More...
 
 DCCPSocket (const IPV6Address &bind, tpport_t port, unsigned backlog=5)
 
 DCCPSocket (const char *name, Family family=IPV4, unsigned backlog=5)
 Create a named dccp socket by service and/or interface id. More...
 
 DCCPSocket (Family family=IPV4)
 Create an unconnected ephemeral DCCP client socket.
 
 DCCPSocket (DCCPSocket &server, timeout_t timeout=0)
 Create a server session by accepting a DCCP Socket.
 
void disconnect (void)
 Disconnect active dccp connection (client use).
 
virtual IPV4Host getIPV4Sender (tpport_t *port=NULL) const
 
virtual IPV6Host getIPV6Sender (tpport_t *port=NULL) const
 
int getRxCCID () const
 Get RX CCID DCCP.
 
int getTxCCID () const
 Get TX CCID DCCP.
 
bool isPendingConnection (timeout_t timeout=ucommon::Timer::inf)
 Used to wait for pending connection requests. More...
 
virtual bool onAccept (const IPV4Host &ia, tpport_t port)
 A method to call in a derived DCCPSocket class that is acting as a server when a connection request is being accepted. More...
 
virtual bool onAccept (const IPV6Host &ia, tpport_t port)
 
void reject (void)
 Used to reject the next incoming connection request.
 
bool setCCID (uint8_t ccid)
 Set CCID DCCP.
 
virtual ~DCCPSocket ()
 Use base socket handler for ending this socket.
 

Detailed Description

DCCP sockets are used for stream based connected sessions between two sockets.

Both error recovery and flow control operate transparently for a DCCP socket connection. The DCCP socket base class is used both for client connections and to bind a DCCP "server" for accepting DCCP streams.

An implicit and unique DCCPSocket object exists in Common C++ to represent a bound DCCP socket acting as a "server" for receiving connection requests. This class is not part of DCCPStream because such objects normally perform no physical I/O (read or write operations) other than to specify a listen backlog queue and perform "accept" operations for pending connections. The Common C++ DCCPSocket offers a Peek method to examine where the next pending connection is coming from, and a Reject method to flush the next request from the queue without having to create a session.

The DCCPSocket also supports a "OnAccept" method which can be called when a DCCPStream related object is created from a DCCPSocket. By creating a DCCPStream from a DCCPSocket, an accept operation automatically occurs, and the DCCPSocket can then still reject the client connection through the return status of it's OnAccept method.

Author
Leandro Sales leand.nosp@m.roal.nosp@m.@gmai.nosp@m.l.co.nosp@m.m
Heverton Stuart hever.nosp@m.tons.nosp@m.ns@gm.nosp@m.ail..nosp@m.com bound server for DCCP streams and sessions.

Definition at line 93 of file dccp.h.

Constructor & Destructor Documentation

◆ DCCPSocket() [1/2]

ost::DCCPSocket::DCCPSocket ( const IPV4Address bind,
tpport_t  port,
unsigned  backlog = 5 
)

A DCCP "server" is created as a DCCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests.

If the server cannot be created, an exception is thrown.

Parameters
bindlocal ip address or interface to use.
portnumber to bind socket under.
backlogsize of connection request queue.

◆ DCCPSocket() [2/2]

ost::DCCPSocket::DCCPSocket ( const char *  name,
Family  family = IPV4,
unsigned  backlog = 5 
)

Create a named dccp socket by service and/or interface id.

For IPV4 we use [host:]svc or [host/]svc for the string. If we have getaddrinfo, we use that to obtain the addr to bind for.

Parameters
nameof host interface and service port to bind.
backlogsize of connection request queue.

Member Function Documentation

◆ connect()

void ost::DCCPSocket::connect ( const IPV4Host host,
tpport_t  port,
timeout_t  timeout = 0 
)

Create a DCCP client connection to a DCCP socket (on a remote machine).

Parameters
hostaddress of remote DCCP server.
portnumber to connect.

◆ isPendingConnection()

bool ost::DCCPSocket::isPendingConnection ( timeout_t  timeout = ucommon::Timer::inf)
inline

Used to wait for pending connection requests.

Returns
true if data packets available.
Parameters
timeoutin milliseconds. TIMEOUT_INF if not specified.

Definition at line 217 of file dccp.h.

◆ onAccept()

virtual bool ost::DCCPSocket::onAccept ( const IPV4Host ia,
tpport_t  port 
)
virtual

A method to call in a derived DCCPSocket class that is acting as a server when a connection request is being accepted.

The server can implement protocol specific rules to exclude the remote socket from being accepted by returning false. The Peek method can also be used for this purpose.

Returns
true if client should be accepted.
Parameters
iainternet host address of the client.
portnumber of the client.

The documentation for this class was generated from the following file: