foxglove::ClientInterface Class Reference

#include <websocket_client.hpp>

Inheritance diagram for foxglove::ClientInterface:

Public Member Functions
virtual void	advertise (const std::vector< ClientAdvertisement > &channels)=0
virtual void	close ()=0
virtual std::future< void >	connect (const std::string &uri)=0
virtual void	connect (const std::string &uri, std::function< void(websocketpp::connection_hdl)> onOpenHandler, std::function< void(websocketpp::connection_hdl)> onCloseHandler=nullptr)=0
virtual void	fetchAsset (const std::string &name, uint32_t requestId)=0
virtual void	getParameters (const std::vector< std::string > &parameterNames, const std::optional< std::string > &requestId)=0
virtual void	publish (ClientChannelId channelId, const uint8_t *buffer, size_t size)=0
virtual void	sendServiceRequest (const ServiceRequest &request)=0
virtual void	setBinaryMessageHandler (BinaryMessageHandler handler)=0
virtual void	setParameters (const std::vector< Parameter > &parameters, const std::optional< std::string > &requestId)=0
virtual void	setTextMessageHandler (TextMessageHandler handler)=0
virtual void	subscribe (const std::vector< std::pair< SubscriptionId, ChannelId >> &subscriptions)=0
virtual void	subscribeParameterUpdates (const std::vector< std::string > &parameterNames)=0
virtual void	unadvertise (const std::vector< ClientChannelId > &channelIds)=0
virtual void	unsubscribe (const std::vector< SubscriptionId > &subscriptionIds)=0
virtual void	unsubscribeParameterUpdates (const std::vector< std::string > &parameterNames)=0

Detailed Description

Definition at line 32 of file websocket_client.hpp.

Member Function Documentation

advertise()

virtual void foxglove::ClientInterface::advertise ( const std::vector< ClientAdvertisement > &  channels )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

close()

virtual void foxglove::ClientInterface::close ( )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

connect() [1/2]

virtual std::future<void> foxglove::ClientInterface::connect ( const std::string &  uri )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

connect() [2/2]

virtual void foxglove::ClientInterface::connect ( const std::string &  uri, std::function< void(websocketpp::connection_hdl)>  onOpenHandler, std::function< void(websocketpp::connection_hdl)>  onCloseHandler = nullptr  )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

fetchAsset()

virtual void foxglove::ClientInterface::fetchAsset ( const std::string &  name, uint32_t  requestId  )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

getParameters()

virtual void foxglove::ClientInterface::getParameters ( const std::vector< std::string > &  parameterNames, const std::optional< std::string > &  requestId  )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

publish()

virtual void foxglove::ClientInterface::publish ( ClientChannelId  channelId, const uint8_t *  buffer, size_t  size  )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

sendServiceRequest()

virtual void foxglove::ClientInterface::sendServiceRequest ( const ServiceRequest &  request )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

setBinaryMessageHandler()

virtual void foxglove::ClientInterface::setBinaryMessageHandler ( BinaryMessageHandler  handler )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

setParameters()

virtual void foxglove::ClientInterface::setParameters ( const std::vector< Parameter > &  parameters, const std::optional< std::string > &  requestId  )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

setTextMessageHandler()

virtual void foxglove::ClientInterface::setTextMessageHandler ( TextMessageHandler  handler )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

subscribe()

virtual void foxglove::ClientInterface::subscribe ( const std::vector< std::pair< SubscriptionId, ChannelId >> &  subscriptions )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

subscribeParameterUpdates()

virtual void foxglove::ClientInterface::subscribeParameterUpdates ( const std::vector< std::string > &  parameterNames )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

unadvertise()

virtual void foxglove::ClientInterface::unadvertise ( const std::vector< ClientChannelId > &  channelIds )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

unsubscribe()

virtual void foxglove::ClientInterface::unsubscribe ( const std::vector< SubscriptionId > &  subscriptionIds )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

unsubscribeParameterUpdates()

virtual void foxglove::ClientInterface::unsubscribeParameterUpdates ( const std::vector< std::string > &  parameterNames )

pure virtual

Implemented in foxglove::Client< ClientConfiguration >.

---

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

• websocket_client.hpp