StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Network::Connection Namespace Reference

Connection namespace. More...

Namespaces

namespace  Read
 Read-side result codes.
namespace  Write
 Write-side result codes.

Typedefs

using HandlerType = int
 Native POSIX socket handle.

Enumerations

enum class  Protocol : int { IPv4 = AF_INET , IPv6 = AF_INET6 }
 Address family for sockets. More...
enum class  Status : unsigned short {
  Connected , Disconnected , Connecting , Disconnecting ,
  Negotiating , Rejected , PeerClosed , Error
}
 Lifecycle of a connection or listener. More...

Functions

constexpr const char * ProtocolString (const Protocol &protocol) noexcept
 Protocol as text.
constexpr int ProtocolInt (const Protocol &protocol) noexcept
 Protocol as AF_* integer.
constexpr const char * ToString (const StormByte::Network::Connection::Read::Result &result) noexcept
 Read result as text.
constexpr const char * ToString (const StormByte::Network::Connection::Write::Result &result) noexcept
 Write result as text.
constexpr const char * StatusToString (const Status &status) noexcept
 Status as text.
constexpr bool IsConnected (const Status &status) noexcept
 Whether the connection is usable for I/O (Connected or Negotiating).

Detailed Description

Connection namespace.

Private connection implementation.

Connection types of the Network module.

Typedef Documentation

◆ HandlerType

Native POSIX socket handle.

Enumeration Type Documentation

◆ Protocol

Address family for sockets.

Enumerator
IPv4 

IPv4 (AF_INET).

IPv6 

IPv6 (AF_INET6).

◆ Status

enum class StormByte::Network::Connection::Status : unsigned short
strong

Lifecycle of a connection or listener.

Enumerator
Connected 

Connection established.

Disconnected 

Closed / idle.

Connecting 

Connect or listen in progress.

Disconnecting 

Shutdown in progress.

Negotiating 

Application-level handshake.

Rejected 

Peer or local rejection.

PeerClosed 

Peer closed the connection.

Error 

Error state.

Function Documentation

◆ IsConnected()

bool StormByte::Network::Connection::IsConnected ( const Status & status)
constexprnoexcept

Whether the connection is usable for I/O (Connected or Negotiating).

Parameters
statusStatus value.
Returns
true if usable.

◆ ProtocolInt()

int StormByte::Network::Connection::ProtocolInt ( const Protocol & protocol)
constexprnoexcept

Protocol as AF_* integer.

Parameters
protocolProtocol value.
Returns
AF_INET or AF_INET6.

◆ ProtocolString()

const char * StormByte::Network::Connection::ProtocolString ( const Protocol & protocol)
constexprnoexcept

Protocol as text.

Parameters
protocolProtocol value.
Returns
Static string literal: "IPv4", "IPv6", or "Unknown".

◆ StatusToString()

const char * StormByte::Network::Connection::StatusToString ( const Status & status)
constexprnoexcept

Status as text.

Parameters
statusStatus value.
Returns
Static string literal naming the status.

◆ ToString() [1/2]

const char * StormByte::Network::Connection::ToString ( const StormByte::Network::Connection::Read::Result & result)
constexprnoexcept

Read result as text.

Parameters
resultRead result.
Returns
Static string literal naming the result.

◆ ToString() [2/2]

const char * StormByte::Network::Connection::ToString ( const StormByte::Network::Connection::Write::Result & result)
constexprnoexcept

Write result as text.

Parameters
resultWrite result.
Returns
Static string literal naming the result.