Class CTimerProtocol

Creates an asynchronous timer that fires on the specified interval until terminated via the async_timer function.

Hierarchy (View Summary)

CProtocol
- CTimerProtocol

Index

Constructors

Methods

name post_message terminate type

Constructors

constructor

new CTimerProtocol(
    params: {
        interval: number;
        name: string;
        rx_handler: CProtocolEventHandler<CTimerEvent>;
    },
): CTimerProtocol
Constructor for the protocol.
Parameters
- params: {
      interval: number;
      name: string;
      rx_handler: CProtocolEventHandler<CTimerEvent>;
  }
  The named parameters.
  - interval: number
    
    How often to fire the timer.
  - name: string
    
    The name to give to the protocol.
  - rx_handler: CProtocolEventHandler<CTimerEvent>
    
    Handler for the protocol.
Returns CTimerProtocol
Overrides CProtocol.constructor
- Defined in codemelted.js:647

Methods

name

name(): string
A log identification.

Returns string
Inherited from CProtocol.name
- Defined in codemelted.js:392

post_message

post_message(data?: any): void
Posts a given message to the given implementing protocol.
Parameters
- Optionaldata: any
  The data to post for the given protocol.
Returns void
Inherited from CProtocol.post_message
- Defined in codemelted.js:405

terminate

terminate(): void
Terminates the given protocol.

Returns void
Overrides CProtocol.terminate
- Defined in codemelted.js:626

type

type(): string
Identifies the type of protocol.

Returns string
Inherited from CProtocol.type
- Defined in codemelted.js:398