NAP
Public Attributes | List of all members
WebSocketComponent Class Reference

#include <websocketcomponent.h>

Public Attributes

nap::ResourcePtr< WebSocketInterfacemInterface
 Property: "Interface" the web-socket client or server this component listens to for events. More...
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Additional Inherited Members

- Public Member Functions inherited from Component
virtual void getDependentComponents (std::vector< rtti::TypeInfo > &components) const
 
virtual const rtti::TypeInfo getInstanceType () const =0
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual bool init (utility::ErrorState &errorState)
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 
- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 

Description

Resource part of the WebSocketComponent, receives web-socket client and server events. Listen to the various signals (nap::WebSocketComponentInstance) to receive websocket events in your application. The events are received on the main application thread. This object ensures thread-safety. Only web-socket events that originated from the given interface (client or server) are accepted.

Inheritance diagram for WebSocketComponent:
[legend]
Collaboration diagram for WebSocketComponent:
[legend]

Member Data Documentation

◆ mInterface

Property: "Interface" the web-socket client or server this component listens to for events.