ost::DCCPSocket(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::DCCPSocket 💖 — from the Library Functions Manual, bestie 🎀

okay so. picture this: you wanna do stream-based connected sessions between two sockets, and DCCP is your girl. that's literally the whole vibe. let's get into it ✨

✨ NAME ✨

ost::DCCPSocket — DCCP sockets are used for stream based connected sessions between two sockets. that's it, that's the elevator pitch 🛗💅

🌸 SYNOPSIS 🌸

#include <socket.h>

Inherits ost::Socket. yes bestie, she's a daughter of Socket, she carries the family name 🫶

🦋 Public Member Functions 🦋

virtual bool onAccept (const IPV4Host &ia, tpport_t port) — a method to call in a derived DCCPSocket class that's acting as a server when a connection request is being accepted.
virtual bool onAccept (const IPV6Host &ia, tpport_t port) — same energy, IPv6 edition.
virtual IPV4Host getIPV4Sender (tpport_t *port=NULL) const — get the IPv4 sender, optionally tell it where to drop the port.
virtual IPV6Host getIPV6Sender (tpport_t *port=NULL) const — IPv6 sender version, same deal.
DCCPSocket (const IPV4Address &bind, tpport_t port, unsigned backlog=5) — a DCCP 'server' gets created as a DCCP socket bound to a hardware address and port number on the local machine, with a backlog queue to listen for remote connection requests.
DCCPSocket (const IPV6Address &bind, tpport_t port, unsigned backlog=5) — the IPv6 twin.
DCCPSocket (const char *name, Family family=IPV4, unsigned backlog=5) — create a named dccp socket by service and/or interface id.
DCCPSocket (Family family=IPV4) — create an unconnected ephemeral DCCP client socket. she's free, she's uncommitted, she's ephemeral 💫
DCCPSocket (DCCPSocket &server, timeout_t timeout=0) — create a server session by accepting a DCCP Socket.
void reject (void) — used to reject the next incoming connection request. not today, bestie 🚫
void disconnect (void) — disconnect active dccp connection (client use).
bool setCCID (uint8 ccid) — set CCID DCCP.
int getTxCCID () — get TX CCID DCCP.
int getRxCCID () — get RX CCID DCCP.
size_t available () — 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).
void connect (const IPV6Host &host, tpport_t port, timeout_t timeout=0) — the IPv6 version, love her.
void connect (const char *name) — connect to a named client.
bool isPendingConnection (timeout_t timeout=TIMEOUT_INF) — used to wait for pending connection requests.
virtual ~DCCPSocket () — use base socket handler for ending this socket. she's logging off, respectfully 💀

🧚 Additional Inherited Members 🧚

yep, there's more where that came from — inherited stuff, we love a rich family tree 🌳

👑 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 leandroal@gmail.com
Heverton Stuart hevertonsns@gmail.com

bound server for DCCP streams and sessions. periodt. 💅

💜 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. like, she will literally throw hands 😭

Parameters

bind — local ip address or interface to use.
port — number to bind socket under.
backlog — size of connection request queue.

`ost::DCCPSocket::DCCPSocket (const IPV6Address & bind, tpport_t port, unsigned backlog = 5)`

the IPv6 remix, no notes 🌈

`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. iykyk 🔥

Parameters

name — of host interface and service port to bind.
backlog — size 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. very giving-plans-to-see-other-sockets energy 🎀

`virtual ost::DCCPSocket::~DCCPSocket () [virtual]`

Use base socket handler for ending this socket. bye bestie, it was real 🌸

🦋 Member Function Documentation 🦋

`size_t ost::DCCPSocket::available ()`

Return number of bytes to be read.

`void ost::DCCPSocket::connect (const char * name)`

Connect to a named client.

`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). long distance relationship but make it a socket 💌

Parameters

host — address of remote DCCP server.
port — number to connect.

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

same but IPv6, she contains multitudes 💜

`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. she's just standing there. menacingly. waiting. 🧍

Returns

true if data packets available.

Parameters

timeout — in 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

ia — internet host address of the client.
port — number of the client.

`virtual bool ost::DCCPSocket::onAccept (const IPV6Host & ia, tpport_t port) [virtual]`

the IPv6 counterpart, serving looks as always 👑

`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 — the IPv4 struct, chilling right there.
struct sockaddr_in6 ost::DCCPSocket::ipv6 — and her IPv6 sister.

💫 Author 💫

Generated automatically by Doxygen for GNU CommonC++ from the source code. not me being auto-generated and still ate 😌

real talk bestie: TIMEOUT_INF means wait forever, and if your DCCP 'server' can't be created, an exception gets thrown. don't say i didn't warn you 💀

that's the whole page, fr fr. GNU CommonC++ · Sun Dec 27 2020 · ost::DCCPSocket(3) — slay, bye, go write some sockets 💅✨🦋

📦 where this page comes from

ubuntu jammy: libcommoncpp2-doc 1.8.1-10
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms