GNU CommonC++
Public Member Functions | List of all members
ost::DCCPSocket Class Reference

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

#include <socket.h>

Inheritance diagram for ost::DCCPSocket:
ost::Socket

Public Member Functions

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)
 
virtual IPV4Host getIPV4Sender (tpport_t *port=NULL) const
 
virtual IPV6Host getIPV6Sender (tpport_t *port=NULL) const
 
 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. More...
 
 DCCPSocket (DCCPSocket &server, timeout_t timeout=0)
 Create a server session by accepting a DCCP Socket. More...
 
void reject (void)
 Used to reject the next incoming connection request. More...
 
void disconnect (void)
 Disconnect active dccp connection (client use). More...
 
bool setCCID (uint8 ccid)
 Set CCID DCCP. More...
 
int getTxCCID ()
 Get TX CCID DCCP. More...
 
int getRxCCID ()
 Get RX CCID DCCP. More...
 
size_t available ()
 Return number of bytes to be read. More...
 
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. More...
 
bool isPendingConnection (timeout_t timeout=TIMEOUT_INF)
 Used to wait for pending connection requests. More...
 
virtual ~DCCPSocket ()
 Use base socket handler for ending this socket. More...
 
- Public Member Functions inherited from ost::Socket
virtual ~Socket ()
 The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object. More...
 
Socketoperator= (const Socket &from)
 Sockets may also be duplicated by the assignment operator. More...
 
IPV4Host getSender (tpport_t *port=NULL) const
 
IPV4Host getIPV4Peer (tpport_t *port=NULL) const
 Get the host address and port of the socket this socket is connected to. More...
 
IPV4Host getPeer (tpport_t *port=NULL) const
 
IPV6Host getIPV6Peer (tpport_t *port=NULL) const
 
IPV4Host getIPV4Local (tpport_t *port=NULL) const
 Get the local address and port number this socket is currently bound to. More...
 
IPV4Host getLocal (tpport_t *port=NULL) const
 
IPV6Host getIPV6Local (tpport_t *port=NULL) const
 
IPV4Host getIPV4NAT (tpport_t *port=NULL) const
 Perform NAT table lookup for this socket. More...
 
IPV4Host getNAT (tpport_t *port) const
 
IPV6Host getIPV6NAT (tpport_t *port=NULL) const
 
void setCompletion (bool immediate)
 Used to specify blocking mode for the socket. More...
 
Error setLinger (bool linger)
 Enable lingering sockets on close. More...
 
Error setKeepAlive (bool enable)
 Set the keep-alive status of this socket and if keep-alive messages will be sent. More...
 
Error setTypeOfService (Tos service)
 Set packet scheduling on platforms which support ip quality of service conventions. More...
 
bool isConnected (void) const
 Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More...
 
bool isActive (void) const
 Test to see if the socket is at least operating or if it is mearly initialized. More...
 
bool operator! () const
 Operator based testing to see if a socket is currently active. More...
 
bool isBroadcast (void) const
 Return if broadcast has been enabled for the specified socket. More...
 
bool isRouted (void) const
 Return if socket routing is enabled. More...
 
Error getErrorNumber (void) const
 Often used by a "catch" to fetch the last error of a thrown socket. More...
 
const char * getErrorString (void) const
 Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used. More...
 
long getSystemError (void) const
 
const char * getSystemErrorString (void) const
 
virtual bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)
 Get the status of pending operations. More...
 

Additional Inherited Members

- Public Types inherited from ost::Socket
enum  Family { IPV6 = AF_INET6, IPV4 = AF_INET }
 
enum  Error {
  errSuccess = 0, errCreateFailed, errCopyFailed, errInput,
  errInputInterrupt, errResourceFailure, errOutput, errOutputInterrupt,
  errNotConnected, errConnectRefused, errConnectRejected, errConnectTimeout,
  errConnectFailed, errConnectInvalid, errConnectBusy, errConnectNoRoute,
  errBindingFailed, errBroadcastDenied, errRoutingDenied, errKeepaliveDenied,
  errServiceDenied, errServiceUnavailable, errMulticastDisabled, errTimeout,
  errNoDelay, errExtended, errLookupFail, errSearchErr,
  errInvalidValue
}
 
enum  Tos {
  tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost,
  tosInvalid
}
 
enum  Pending { pendingInput, pendingOutput, pendingError }
 
typedef enum Family Family
 
typedef enum Error Error
 
typedef enum Tos Tos
 
typedef enum Pending Pending
 
- Static Public Member Functions inherited from ost::Socket
static bool check (Family fam)
 See if a specific protocol family is available in the current runtime environment. More...
 
- Protected Types inherited from ost::Socket
enum  State {
  INITIAL, AVAILABLE, BOUND, CONNECTED,
  CONNECTING, STREAM
}
 
typedef enum State State
 
- Protected Member Functions inherited from ost::Socket
Error error (Error error, const char *err=NULL, long systemError=0) const
 This service is used to throw all socket errors which usually occur during the socket constructor. More...
 
void error (const char *err) const
 This service is used to throw application defined socket errors where the application specific error code is a string. More...
 
void setError (bool enable)
 This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. More...
 
void endSocket (void)
 Used as the default destructor for ending a socket. More...
 
Error connectError (void)
 Used as a common handler for connection failure processing. More...
 
Error sendLimit (int limit=2048)
 Set the send limit. More...
 
Error receiveLimit (int limit=1)
 Set thr receive limit. More...
 
Error sendTimeout (timeout_t timer)
 Set the send timeout for sending raw network data. More...
 
Error receiveTimeout (timeout_t timer)
 Receive timeout for receiving raw network data. More...
 
Error sendBuffer (unsigned size)
 Set the protocol stack network kernel send buffer size associated with the socket. More...
 
Error receiveBuffer (unsigned size)
 Set the protocol stack network kernel receive buffer size associated with the socket. More...
 
Error bufferSize (unsigned size)
 Set the total protocol stack network kernel buffer size for both send and receive together. More...
 
Error setBroadcast (bool enable)
 Set the subnet broadcast flag for the socket. More...
 
Error setMulticastByFamily (bool enable, Family family=IPV4)
 Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. More...
 
Error setLoopbackByFamily (bool enable, Family family=IPV4)
 Set the multicast loopback flag for the socket. More...
 
Error setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4)
 Set the multicast time to live for a multicast socket. More...
 
Error join (const IPV4Multicast &ia)
 Join a multicast group. More...
 
Error join (const IPV6Multicast &ia)
 
Error drop (const IPV4Multicast &ia)
 Drop membership from a multicast group. More...
 
Error drop (const IPV6Multicast &ia)
 
Error setRouting (bool enable)
 Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More...
 
Error setNoDelay (bool enable)
 Enable/disable delaying packets (Nagle algorithm) More...
 
 Socket (int domain, int type, int protocol=0)
 An unconnected socket may be created directly on the local machine. More...
 
 Socket (SOCKET fd)
 A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. More...
 
 Socket ()
 Create an inactive socket object for base constructors. More...
 
 Socket (const Socket &source)
 A socket can also be constructed from an already existing Socket object. More...
 
ssize_t readLine (char *buf, size_t len, timeout_t timeout=0)
 Process a logical input line from a socket descriptor directly. More...
 
virtual ssize_t readData (void *buf, size_t len, char separator=0, timeout_t t=0)
 Read in a block of len bytes with specific separator. More...
 
virtual ssize_t writeData (const void *buf, size_t len, timeout_t t=0)
 Write a block of len bytes to socket. More...
 
- Protected Attributes inherited from ost::Socket
struct {
   bool   thrown: 1
 
   bool   broadcast: 1
 
   bool   route: 1
 
   bool   keepalive: 1
 
   bool   loopback: 1
 
   bool   multicast: 1
 
   bool   completion: 1
 
   bool   linger: 1
 
   unsigned   ttl: 8
 
flags
 
SOCKET volatile so
 the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc More...
 
State volatile state
 
- Static Protected Attributes inherited from ost::Socket
static Mutex mutex
 

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.

Constructor & Destructor Documentation

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.
ost::DCCPSocket::DCCPSocket ( const IPV6Address bind,
tpport_t  port,
unsigned  backlog = 5 
)
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.
ost::DCCPSocket::DCCPSocket ( Family  family = IPV4)

Create an unconnected ephemeral DCCP client socket.

ost::DCCPSocket::DCCPSocket ( DCCPSocket server,
timeout_t  timeout = 0 
)

Create a server session by accepting a DCCP Socket.

virtual ost::DCCPSocket::~DCCPSocket ( )
virtual

Use base socket handler for ending this socket.

Member Function Documentation

size_t ost::DCCPSocket::available ( )

Return number of bytes to be read.

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.
void ost::DCCPSocket::connect ( const IPV6Host host,
tpport_t  port,
timeout_t  timeout = 0 
)
void ost::DCCPSocket::connect ( const char *  name)

Connect to a named client.

void ost::DCCPSocket::disconnect ( void  )

Disconnect active dccp connection (client use).

virtual IPV4Host ost::DCCPSocket::getIPV4Sender ( tpport_t port = NULL) const
virtual

Reimplemented from ost::Socket.

virtual IPV6Host ost::DCCPSocket::getIPV6Sender ( tpport_t port = NULL) const
virtual

Reimplemented from ost::Socket.

int ost::DCCPSocket::getRxCCID ( )

Get RX CCID DCCP.

int ost::DCCPSocket::getTxCCID ( )

Get TX CCID DCCP.

bool ost::DCCPSocket::isPendingConnection ( timeout_t  timeout = TIMEOUT_INF)
inline

Used to wait for pending connection requests.

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

References ost::Socket::isPending(), and ost::Socket::pendingInput.

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.
virtual bool ost::DCCPSocket::onAccept ( const IPV6Host ia,
tpport_t  port 
)
virtual
void ost::DCCPSocket::reject ( void  )

Used to reject the next incoming connection request.

bool ost::DCCPSocket::setCCID ( uint8  ccid)

Set CCID DCCP.

Member Data Documentation

struct sockaddr_in ost::DCCPSocket::ipv4
struct sockaddr_in6 ost::DCCPSocket::ipv6

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