Open 3D Engine BarrierInput Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
BarrierInput::BarrierClient Class Reference

Barrier client that manages a connection with a Barrier server. More...

#include <BarrierInputClient.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (BarrierClient, AZ::SystemAllocator)
 
 BarrierClient (const char *clientScreenName, const char *serverHostName, AZ::u32 connectionPort=DEFAULT_BARRIER_CONNECTION_PORT_NUMBER)
 
 ~BarrierClient ()
 Destructor.
 
const AZStd::string & GetClientScreenName () const
 
const AZStd::string & GetServerHostName () const
 
const AZSOCKET & GetSocket () const
 

Static Public Attributes

static constexpr AZ::u32 DEFAULT_BARRIER_CONNECTION_PORT_NUMBER = 24800
 

Protected Member Functions

void Run ()
 The client connection loop that runs in it's own thread.
 
bool ConnectToServer ()
 

Detailed Description

Barrier client that manages a connection with a Barrier server.

Constructor & Destructor Documentation

◆ BarrierClient()

BarrierInput::BarrierClient::BarrierClient ( const char *  clientScreenName,
const char *  serverHostName,
AZ::u32  connectionPort = DEFAULT_BARRIER_CONNECTION_PORT_NUMBER 
)

Constructor

Parameters
[in]clientScreenNameName of the Barrier client screen this class implements
[in]serverHostNameName of the Barrier server host this client connects to
[in]connectionPortPort number over which to connect to the Barrier server

Member Function Documentation

◆ ConnectToServer()

bool BarrierInput::BarrierClient::ConnectToServer ( )
protected

Try to connect to the Barrier server

Returns
True if we're connected to the Barrier server, false otherwise

◆ GetClientScreenName()

const AZStd::string& BarrierInput::BarrierClient::GetClientScreenName ( ) const
inline

Access to the Barrier client screen this class implements

Returns
Name of the Barrier client screen this class implements

◆ GetServerHostName()

const AZStd::string& BarrierInput::BarrierClient::GetServerHostName ( ) const
inline

Access to the Barrier server host this client connects to

Returns
Name of the Barrier server host this client connects to

◆ GetSocket()

const AZSOCKET& BarrierInput::BarrierClient::GetSocket ( ) const
inline

Access to the socket the Barrier client is communicating over

Returns
The socket the Barrier client is communicating over
The documentation for this class was generated from the following file: