alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface Class Reference

#include <MessagingServerInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface:

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface:

Public Member Functions
virtual bool	start ()=0
virtual void	stop ()=0
virtual bool	isReady ()=0
virtual void	setObserver (const std::shared_ptr< MessagingServerObserverInterface > &observer)=0
Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingInterface
virtual void	writeMessage (const std::string &payload)=0
virtual void	setMessageListener (std::shared_ptr< MessageListenerInterface > messageListener)=0

Detailed Description

Server with a MessagingInterface capabilities.

Member Function Documentation

isReady()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface::isReady ( )

pure virtual

Is the medium ready for passing messages

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::WebSocketServer.

setObserver()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface::setObserver ( const std::shared_ptr< MessagingServerObserverInterface > &  observer )

pure virtual

Set server observer.

Parameters

observer

The observer which should gets notified whenever a new connection is open or a connection is closed.

start()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface::start ( )

pure virtual

Start the implementation of the MessagingInterface

Note

The implementation may choose to make this method blocking or non blocking.

Returns

true for success. False otherwise.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::WebSocketServer.

stop()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::MessagingServerInterface::stop ( )

pure virtual

Stop the messaging implmentation

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::communication::WebSocketServer.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/Communication/include/Communication/MessagingServerInterface.h