Class CProtocolEvent<T>

An event handled by a currently opened CProtocol. The event is handled via the CProtocolEventHandler.

Template: T

The event objects a protocol is working with.

Type Parameters

T
The event objects a protocol is working with.

Index

Constructors

Methods

data event_fired protocol

Constructors

constructor

new CProtocolEvent<T>(
params: { data: any; event_fired: string; protocol: CProtocol<T> },
): CProtocolEvent<T>
Constructor for the event.
Type Parameters
- T
  The event objects a protocol is working with.
Parameters
- params: { data: any; event_fired: string; protocol: CProtocol<T> }
  The named parameters.
  - data: any
    
    The data handled by the protocol.
  - event_fired: string
    
    The event that was handled.
  - protocol: CProtocol<T>
    
    The protocol associated with the event.
Returns CProtocolEvent<T>
- Defined in codemelted.js:330

Methods

data

data(): T
The data received by the event. Utilize the as_xxx() functions to retrieve a specific data type for the given protocol_type().

Returns T
- Defined in codemelted.js:314

event_fired

event_fired(): string
Retrieves the event that was fired with the open protocol.

Returns string
- Defined in codemelted.js:320

protocol

protocol(): CProtocol<T>
Identification of the protocol. Utilized for logging purposes.

Returns CProtocol<T>
- Defined in codemelted.js:307