HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_WebSocketSet::Event Class Reference

Describes an event that has occured. More...

#include <NET_WebSocketSet.h>

Public Types

enum  Type {
  UNKNOWN, ERROR, CONNECTED, CONNECT_ERROR,
  DISCONNECTED, DISCONNECT_ERROR, MESSAGE_SENT, MESSAGE_SEND_ERROR,
  MESSAGE_RECEIVED, MESSAGE_RECEIVE_ERROR
}
 

Public Member Functions

 Event ()=default
 
 Event (const Type &type, const UT_StringHolder &id, const NET_Time &t)
 

Public Attributes

Type myType
 The type of event that occured. More...
 
UT_Url myUrl
 The url that the event originated from. More...
 
UT_StringHolder myId
 The connection id the event originated from. More...
 
NET_Time myTimestamp
 The time at which the event occured. More...
 
UT_StringHolder myError
 The error message if this is an error that occured. More...
 
UT_StringHolder myMessage
 The message for the event. In the case of a message event this is the read in event. In all other cases this describes the details of the event in English. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const Event ev)
 

Detailed Description

Describes an event that has occured.

Definition at line 42 of file NET_WebSocketSet.h.

Member Enumeration Documentation

Enumerator
UNKNOWN 
ERROR 
CONNECTED 
CONNECT_ERROR 
DISCONNECTED 
DISCONNECT_ERROR 
MESSAGE_SENT 
MESSAGE_SEND_ERROR 
MESSAGE_RECEIVED 
MESSAGE_RECEIVE_ERROR 

Definition at line 45 of file NET_WebSocketSet.h.

Constructor & Destructor Documentation

NET_WebSocketSet::Event::Event ( )
default
NET_WebSocketSet::Event::Event ( const Type type,
const UT_StringHolder id,
const NET_Time t 
)
inline

Definition at line 60 of file NET_WebSocketSet.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const Event  ev 
)
friend

Definition at line 70 of file NET_WebSocketSet.h.

Member Data Documentation

UT_StringHolder NET_WebSocketSet::Event::myError

The error message if this is an error that occured.

Definition at line 124 of file NET_WebSocketSet.h.

UT_StringHolder NET_WebSocketSet::Event::myId

The connection id the event originated from.

Definition at line 120 of file NET_WebSocketSet.h.

UT_StringHolder NET_WebSocketSet::Event::myMessage

The message for the event. In the case of a message event this is the read in event. In all other cases this describes the details of the event in English.

Definition at line 129 of file NET_WebSocketSet.h.

NET_Time NET_WebSocketSet::Event::myTimestamp

The time at which the event occured.

Definition at line 122 of file NET_WebSocketSet.h.

Type NET_WebSocketSet::Event::myType

The type of event that occured.

Definition at line 115 of file NET_WebSocketSet.h.

UT_Url NET_WebSocketSet::Event::myUrl

The url that the event originated from.

Definition at line 118 of file NET_WebSocketSet.h.


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