p2p::P2PClient::NetworkListenerRegistration¶
-
class
kanzi::connect::p2p::P2PClient
::
NetworkListenerRegistration
: public NetworkListenerClient::Observer, public MessageDispatcher Class to facade a network listener client and message dispatching.
Public Types
-
enum
State
Values:
-
enumerator
StateDisconnected
Disconnected.
-
enumerator
StateConnecting
Connecting started but not yet established.
-
enumerator
StateConnected
Connected.
-
enumerator
StateWaitingReconnect
After unsuccesfull connect a wait state after which next reconnect attempt is made.
-
enumerator
Public Functions
Constructor.
- Parameters
networkListener – The listener that this registration represents.
client – Client instance. Ownerhip is not transfered.
serverclientid – The identifier number that this client has on a server.
verboseLogging – When set to true, the information is printed in verbose manner.
-
~NetworkListenerRegistration
() Destructor.
-
inline void
addStateChangeCallback
(ConnectionStateChangedFunctionType callback) Insert callback to listen to registration changes.
- Parameters
callback – The method to invoke for changes. You can set only one callback.
Checks whether this paritucular network listener can handle the particular endpoint.
- Parameters
endpoint – the endpoint to check.
- Returns
true if this listener can handle provided endpoint
-
size_t
countEndpoints
() const Return amount of endpoints the class has.
- Returns
amount of endpoints
-
inline void
enableVerboseLogging
(bool enable) Controls logging verbosity.
- Parameters
enable – true to enable verbose logging from the class.
Inserts a new endpoint.
- Parameters
endpoint – the endpoint to insert
-
inline bool
isConnected
() const Connection state retrieval.
- Returns
true if connected currently.
-
inline bool
isDisconnected
() const Connection state retrieval.
- Returns
true if disconnected currently.
-
virtual void onConnected () KZ_OVERRIDE
Listener thread has established connection to server.
-
virtual void onDisconnected () KZ_OVERRIDE
Listener thread has terminated connection from server.
-
virtual void onFailedToConnect () KZ_OVERRIDE
Listener thread failed to connect.
-
virtual void onReceive () KZ_OVERRIDE
Listener thread received data.
Checks whether this registration refers to a specified endpoint.
- Parameters
endpoint – the endpoint to check
- Returns
true if refers to endpoint.
Removes a endpoint.
- Parameters
endpoint – the endpoint to remove.
- Returns
true if endpoint was referenced and got removed.
-
bool
startConnect
() Starts connection establishment.
- Returns
true if successfully started.
-
void
stop
() Stops the operation including the worker thread.
-
string
toString
() Get stringular representation of the network connection.
mainly for debugging purposes
- Returns
stringular representation of the network connection.
-
bool
unreliableLink
() Describe the link type whether it is reliable or unreliable.
By default, all the links are assumed to be reliable unless otherwise explicitly stated by the network adapter
- Returns
true if link is considered unreliable.
-
void
work
() To be invoked to process incoming messages from the network listener.
-
enum