Kanzi Connect  3.9.8
Kanzi Connect C++ API
Public Types | Public Member Functions | List of all members
kanzi::connect::IncomingMessageInterface Class Referenceabstract

Abstract message router interface for incoming messages. More...

#include <incoming_message_interface.hpp>

Inheritance diagram for kanzi::connect::IncomingMessageInterface:
kanzi::connect::ServiceManager

Public Types

enum  Status {
  Ok = 0, ErrorGeneric, ErrorInvalidMessage, ErrorUnknownDestination,
  ErrorNotRunning
}
 
typedef enum kanzi::connect::IncomingMessageInterface::Status Status
 

Public Member Functions

virtual IncomingMessageInterface::Status handleIncomingMessage (ConnectedClientSharedPtr connectedClient, const MessagePackage &message)=0
 Routes a message from a client to right destination. More...
 
virtual IncomingMessageInterface::Status validateServiceState (const string &serviceIdentifier)=0
 

Detailed Description

Abstract message router interface for incoming messages.

Member Typedef Documentation

◆ Status

typedef enum kanzi::connect::IncomingMessageInterface::Status kanzi::connect::IncomingMessageInterface::Status

Member Enumeration Documentation

◆ Status

enum kanzi::connect::IncomingMessageInterface::Status
Enumerator
Ok 

Message handled OK.

ErrorGeneric 

Generic error, reason unknown.

ErrorInvalidMessage 

Received message did not contain all the relevant information.

ErrorUnknownDestination 

Target not found.

ErrorNotRunning 

Server was not running.

Member Function Documentation

◆ handleIncomingMessage()

virtual IncomingMessageInterface::Status kanzi::connect::IncomingMessageInterface::handleIncomingMessage ( ConnectedClientSharedPtr  connectedClient,
const MessagePackage &  message 
)
pure virtual

Routes a message from a client to right destination.

Parameters
messagethe message that got received.
connectedClientdefines the client that sent the message
Returns
Ok if message got routed - some error otherwise.

◆ validateServiceState()

virtual IncomingMessageInterface::Status kanzi::connect::IncomingMessageInterface::validateServiceState ( const string &  serviceIdentifier)
pure virtual
The documentation for this class was generated from the following file: