Client Class Reference

#include <client.hpp>

Inheritance diagram for Client:

Collaboration diagram for Client:

Public Types
using	CompletionCallback = std::function<void(Client&, CompletionStatus)>

Public Member Functions
	Client (asio::ip::tcp::socket &&socket)
	Client (Client &&)=delete
	Client (const Client &)=delete
const std::vector< std::string > &	getCandidates ()
std::string	getClientName ()
std::string	getRoomName ()
std::string	getSdpDesc ()
bool	isSendCallbackPending () const
Client &	operator= (Client &&)=delete
Client &	operator= (const Client &)=delete
void	readCandidate (CompletionCallback onComplete)
void	readDescription (CompletionCallback onComplete)
void	sendMsg (std::string_view msg)

Private Member Functions
void	onMsgSent (CompletionStatus status)
void	readCandidateComplete (CompletionCallback onComplete, CompletionStatus status)
void	readDescComplete (CompletionCallback onComplete, CompletionStatus status)
void	readNameComplete (asio::ip::tcp::socket &socket, CompletionCallback onComplete, CompletionStatus status)
void	readRoomComplete (asio::ip::tcp::socket &socket, CompletionCallback onComplete, CompletionStatus status)

Private Attributes
std::vector< std::string >	candidates
std::string	clientName
Message	inMsg
Message	outMsg
std::string	roomName
std::string	sdpDesc
std::queue< std::string >	sendQueue
asio::ip::tcp::socket	socket

Detailed Description

Definition at line 49 of file client.hpp.

Member Typedef Documentation

CompletionCallback

using Client::CompletionCallback = std::function<void(Client&, CompletionStatus)>

Definition at line 51 of file client.hpp.

Constructor & Destructor Documentation

Client() [1/3]

Client::Client

(

asio::ip::tcp::socket &&

socket

)

Definition at line 40 of file client.cpp.

: socket(std::move(socket)) {  }

Client() [2/3]

Client::Client ( const Client & )

delete

Client() [3/3]

Client::Client ( Client && )

delete

Member Function Documentation

getCandidates()

const std::vector< std::string > & Client::getCandidates ( )

inline

Definition at line 68 of file client.hpp.

{ return candidates; }

References candidates.

getClientName()

std::string Client::getClientName ( )

inline

Definition at line 61 of file client.hpp.

{ return clientName; }

References clientName.

Referenced by Room::addClient().

getRoomName()

std::string Client::getRoomName ( )

inline

Definition at line 62 of file client.hpp.

{ return roomName; }

References roomName.

getSdpDesc()

std::string Client::getSdpDesc ( )

inline

Definition at line 63 of file client.hpp.

{ return sdpDesc; }

References sdpDesc.

Referenced by Room::addClient().

isSendCallbackPending()

bool Client::isSendCallbackPending

(

)

const

Definition at line 118 of file client.cpp.

                                        {
        return !sendQueue.empty() || outMsg.isSendingNow();
}

References Message::isSendingNow(), outMsg, and sendQueue.

Referenced by sendMsg().

Here is the call graph for this function:

onMsgSent()

void Client::onMsgSent ( CompletionStatus status )

private

Definition at line 134 of file client.cpp.

                                             {
        if(status != CompletionStatus::Success){
                std::cerr << "Failed to send a message\n";
        }
 
        if(sendQueue.empty())
                return;
 
        using namespace std::placeholders;
        outMsg.setStr(sendQueue.front());
        sendQueue.pop();
        outMsg.async_sendMsg(socket, std::bind(&Client::onMsgSent, shared_from_this(), _1));
}

References Message::async_sendMsg(), onMsgSent(), outMsg, sendQueue, Message::setStr(), socket, and Success.

Referenced by onMsgSent(), and sendMsg().

Here is the call graph for this function:

operator=() [1/2]

Client & Client::operator= ( Client && )

delete

operator=() [2/2]

Client & Client::operator= ( const Client & )

delete

readCandidate()

void Client::readCandidate

(

CompletionCallback

onComplete

)

Definition at line 93 of file client.cpp.

                                                       {
        using namespace std::placeholders;
        inMsg.async_readMsg(socket,
                        std::bind(&Client::readCandidateComplete,
                                shared_from_this(), onComplete, _1));
}

References Message::async_readMsg(), inMsg, readCandidateComplete(), and socket.

Referenced by Room::addClient().

Here is the call graph for this function:

readCandidateComplete()

void Client::readCandidateComplete ( CompletionCallback onComplete, CompletionStatus status )

private

Definition at line 100 of file client.cpp.

{
        if(status != CompletionStatus::Success){
                onComplete(*this, status);
                return;
        }
 
        if(inMsg.getStr() == "disconnect"){
                onComplete(*this, CompletionStatus::GracefulDisconnect);
                return;
        }
 
        candidates.emplace_back(inMsg.getStr());
        onComplete(*this, CompletionStatus::Success);
}

References candidates, Message::getStr(), GracefulDisconnect, inMsg, and Success.

Referenced by readCandidate().

Here is the call graph for this function:

readDescComplete()

void Client::readDescComplete ( CompletionCallback onComplete, CompletionStatus status )

private

Definition at line 80 of file client.cpp.

{
        if(status != CompletionStatus::Success){
                onComplete(*this, status);
                return;
        }
 
        sdpDesc = std::string(inMsg.getStr());
        onComplete(*this, CompletionStatus::Success);
}

References Message::getStr(), inMsg, sdpDesc, and Success.

Referenced by readRoomComplete().

Here is the call graph for this function:

readDescription()

void Client::readDescription

(

CompletionCallback

onComplete

)

Definition at line 42 of file client.cpp.

                                                         {
        using namespace std::placeholders;
        inMsg.async_readMsg(socket,
                        std::bind(&Client::readNameComplete,
                                shared_from_this(), std::ref(socket), onComplete, _1));
}

References Message::async_readMsg(), inMsg, readNameComplete(), and socket.

Here is the call graph for this function:

readNameComplete()

void Client::readNameComplete ( asio::ip::tcp::socket & socket, CompletionCallback onComplete, CompletionStatus status )

private

Definition at line 49 of file client.cpp.

{
        if(status != CompletionStatus::Success){
                onComplete(*this, status);
                return;
        }
 
        clientName = std::string(inMsg.getStr());
        using namespace std::placeholders;
        inMsg.async_readMsg(socket,
                        std::bind(&Client::readRoomComplete,
                                shared_from_this(), std::ref(socket), onComplete, _1));
}

References Message::async_readMsg(), clientName, Message::getStr(), inMsg, readRoomComplete(), socket, and Success.

Referenced by readDescription().

Here is the call graph for this function:

readRoomComplete()

void Client::readRoomComplete ( asio::ip::tcp::socket & socket, CompletionCallback onComplete, CompletionStatus status )

private

Definition at line 65 of file client.cpp.

{
        if(status != CompletionStatus::Success){
                onComplete(*this, status);
                return;
        }
 
        roomName = std::string(inMsg.getStr());
        using namespace std::placeholders;
        inMsg.async_readMsg(socket,
                        std::bind(&Client::readDescComplete, shared_from_this(), onComplete, _1));
}

References Message::async_readMsg(), Message::getStr(), inMsg, readDescComplete(), roomName, socket, and Success.

Referenced by readNameComplete().

Here is the call graph for this function:

sendMsg()

void Client::sendMsg

(

std::string_view

msg

)

Definition at line 123 of file client.cpp.

                                      {
        if(isSendCallbackPending()){
                sendQueue.emplace(msg);
                return;
        }
 
        outMsg.setStr(msg);
        using namespace std::placeholders;
        outMsg.async_sendMsg(socket, std::bind(&Client::onMsgSent, shared_from_this(), _1));
}

References Message::async_sendMsg(), isSendCallbackPending(), onMsgSent(), outMsg, sendQueue, Message::setStr(), and socket.

Referenced by Room::addClient().

Here is the call graph for this function:

Member Data Documentation

candidates

std::vector<std::string> Client::candidates

private

Definition at line 90 of file client.hpp.

Referenced by getCandidates(), and readCandidateComplete().

clientName

std::string Client::clientName

private

Definition at line 87 of file client.hpp.

Referenced by getClientName(), and readNameComplete().

inMsg

Message Client::inMsg

private

Definition at line 94 of file client.hpp.

Referenced by readCandidate(), readCandidateComplete(), readDescComplete(), readDescription(), readNameComplete(), and readRoomComplete().

outMsg

Message Client::outMsg

private

Definition at line 95 of file client.hpp.

Referenced by isSendCallbackPending(), onMsgSent(), and sendMsg().

roomName

std::string Client::roomName

private

Definition at line 88 of file client.hpp.

Referenced by getRoomName(), and readRoomComplete().

sdpDesc

std::string Client::sdpDesc

private

Definition at line 89 of file client.hpp.

Referenced by getSdpDesc(), and readDescComplete().

sendQueue

std::queue<std::string> Client::sendQueue

private

Definition at line 92 of file client.hpp.

Referenced by isSendCallbackPending(), onMsgSent(), and sendMsg().

socket

asio::ip::tcp::socket Client::socket

private

Definition at line 96 of file client.hpp.

Referenced by onMsgSent(), readCandidate(), readDescription(), readNameComplete(), readRoomComplete(), and sendMsg().

---

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

• nat-helper/client.hpp
• nat-helper/client.cpp