Intel® Collaboration Suite for WebRTC  version 4.3.1
Open WebRTC Toolkit (OWT) Client SDK for Windows*
owt::p2p::P2PSignalingChannelInterface Class Referenceabstract

Protocol for signaling channel. Developers may utilize their own signaling server by implmenting this protocol. More...

#include <owt/p2p/p2psignalingchannelinterface.h>

Public Member Functions

virtual void AddObserver (P2PSignalingChannelObserver &observer)=0
 Add an observer for P2PSignalingChannel. More...
 
virtual void RemoveObserver (P2PSignalingChannelObserver &observer)=0
 Remove an observer for P2PSignalingChannel. More...
 
virtual void Connect (const std::string &host, const std::string &token, std::function< void(const std::string &)> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)=0
 Connect to the signaling server. More...
 
virtual void Disconnect (std::function< void()> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)=0
 Disconnect from signaling server.
 
virtual void SendMessage (const std::string &message, const std::string &target_id, std::function< void()> on_success, std::function< void(std::unique_ptr< Exception >)> on_failure)=0
 Send a message to a target client. More...
 

Detailed Description

Protocol for signaling channel. Developers may utilize their own signaling server by implmenting this protocol.

Member Function Documentation

◆ AddObserver()

virtual void owt::p2p::P2PSignalingChannelInterface::AddObserver ( P2PSignalingChannelObserver observer)
pure virtual

Add an observer for P2PSignalingChannel.

Parameters
observerAn observer instance.

◆ Connect()

virtual void owt::p2p::P2PSignalingChannelInterface::Connect ( const std::string &  host,
const std::string &  token,
std::function< void(const std::string &)>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)
pure virtual

Connect to the signaling server.

Parameters
hostThe URL of signaling server to connect
tokenA token used for connecting signaling server

◆ RemoveObserver()

virtual void owt::p2p::P2PSignalingChannelInterface::RemoveObserver ( P2PSignalingChannelObserver observer)
pure virtual

Remove an observer for P2PSignalingChannel.

Parameters
observerAn observer instance.

◆ SendMessage()

virtual void owt::p2p::P2PSignalingChannelInterface::SendMessage ( const std::string &  message,
const std::string &  target_id,
std::function< void()>  on_success,
std::function< void(std::unique_ptr< Exception >)>  on_failure 
)
pure virtual

Send a message to a target client.

Parameters
messageMessage needs to be send to signaling server
target_idTarget user's ID.