Kanzi Connect  3.9.8
Kanzi Connect C++ API
kanzi::connect::ClientDescriptor Class Reference

Contains client description information. More...

#include <client_descriptor.hpp>

Public Member Functions

 ClientDescriptor (ClientIdentifier id, string ip)
 C++ constructor. More...
 
 ClientDescriptor (ConnectedClientSharedPtr connectedClient)
 C++ constructor. More...
 
const string & getAddress () const
 Get the client address. More...
 
ClientIdentifier getId () const
 Get the client identifier. More...
 

Detailed Description

Contains client description information.

This is used for identification purposes only and contains no functionality.

Constructor & Destructor Documentation

◆ ClientDescriptor() [1/2]

kanzi::connect::ClientDescriptor::ClientDescriptor ( ClientIdentifier  id,
string  ip 
)

C++ constructor.

Parameters
ididentifier for the client. Locally unique.
ipaddress of the client.

◆ ClientDescriptor() [2/2]

kanzi::connect::ClientDescriptor::ClientDescriptor ( ConnectedClientSharedPtr  connectedClient)

C++ constructor.

Parameters
connectedClientshared pointer to client information from which relevant is retrieved.

Member Function Documentation

◆ getAddress()

const string& kanzi::connect::ClientDescriptor::getAddress ( ) const

Get the client address.

Returns
address.

◆ getId()

ClientIdentifier kanzi::connect::ClientDescriptor::getId ( ) const

Get the client identifier.

Returns
the identifier

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