---
name: "ost_UDPDuplex"
section: "3"
platform: "linux"
package: "libcommoncpp2-doc"
version: "1.8.1-10"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/ost_UDPDuplex"
---

# ost\_UDPDuplex(3)

UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.

## NAME

ost::UDPDuplex - UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.

## SYNOPSIS

`#include <socket.h>`

Inherits **ost::UDPTransmit**, and **ost::UDPReceive**.

### Public Member Functions

**UDPDuplex** (const **IPV4Address** &bind, **tpport\_t** port)\
 Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses.  **UDPDuplex** (const **IPV6Address** &bind, **tpport\_t** port)\
 **Error** **connect** (const **IPV4Host** &host, **tpport\_t** port)\
 Associate the duplex with a specified peer host.  **Error** **connect** (const **IPV6Host** &host, **tpport\_t** port)\
 **Error** **disconnect** (void)\
 Disassociate this duplex from any host connection.

### Additional Inherited Members

## Detailed Description

UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.

Two UDP sockets are typically used on alternating port addresses to assure that sender and receiver data does not collide or echo back. A UDP Duplex is commonly used for full duplex real-time streaming of UDP data between hosts.

**Author**

David Sugar dyfet@ostel.com

Unreliable Datagram Peer Associations.

## Constructor & Destructor Documentation

### ost::UDPDuplex::UDPDuplex (const IPV4Address & bind, tpport\_t port)

Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses.

**Parameters**

*bind* address to bind this socket to. \
 *port* number to bind sender.

### ost::UDPDuplex::UDPDuplex (const IPV6Address & bind, tpport\_t port)

## Member Function Documentation

### Error ost::UDPDuplex::connect (const IPV4Host & host, tpport\_t port)

Associate the duplex with a specified peer host. Both the sender and receiver will be interconnected with the remote host.

**Returns**

0 on success, error code on error.

**Parameters**

*host* address to connect socket to. \
 *port* number to connect socket to.

### Error ost::UDPDuplex::connect (const IPV6Host & host, tpport\_t port)

### Error ost::UDPDuplex::disconnect (void)

Disassociate this duplex from any host connection. No data should be read or written until a connection is established.

**Returns**

0 on success, error code on error.

## Author

Generated automatically by Doxygen for GNU CommonC++ from the source code.