1. Home
  2. Documentation
  3. API
  4. Telegram Class Reference

Telegram Class Reference

#include <Telegram.h>

Inheritance diagram for Telegram:
Object

# Public Member Functions

void constructor (void *sender, void *receiver, int32 message, void *extraInfo)
void * getSender ()
void * getReceiver ()
int32 getMessage ()
void * getExtraInfo ()

# Protected Attributes

int32 message
 The message's code.
void * extraInfo
 Additional information that may accompany the message.
void * sender
 The object that sends the message.
void * receiver
 The object that receives the message.

# Additional Inherited Members

- Private Member Functions inherited from Object
void constructor ()
 Class' constructor.
const void * getVTable ()
bool mutateTo (const void *targetClass)
- Static Private Member Functions inherited from Object
static Object getCast (void *object, ClassPointer targetClassGetClassMethod, ClassPointer baseClassGetClassMethod)
- Private Attributes inherited from Object
void * vTable
 Pointer to the class's virtual table.

# Detailed Description

Class Telegram

Inherits from Object

Wraps a message to be sent to an Object.

Definition at line 28 of file Telegram.h.

# Member Function Documentation

# constructor()

void Telegram::constructor ( void * sender,
void * receiver,
int32 message,
void * extraInfo )

Class' constructor

Parameters
senderThe object that sends the message
receiverThe object that sends the message
messageThe message's code
extraInfoAdditional information that may accompany the message

Definition at line 22 of file Telegram.c.

# getExtraInfo()

void * Telegram::getExtraInfo ( )

Retrieve the Telegram's sender.

Returns
Additional information that may accompany the message

Definition at line 71 of file Telegram.c.

# getMessage()

int32 Telegram::getMessage ( )

Retrieve the Telegram's message code.

Returns
The message's code

Definition at line 64 of file Telegram.c.

# getReceiver()

void * Telegram::getReceiver ( )

Retrieve the Telegram's receiver.

Returns
Pointer to the object that receives the message

Definition at line 57 of file Telegram.c.

# getSender()

void * Telegram::getSender ( )

Retrieve the Telegram's sender.

Returns
Pointer to the object that sent the message

Definition at line 50 of file Telegram.c.

# Member Data Documentation

# extraInfo

void* Telegram::extraInfo
protected

Additional information that may accompany the message.

Definition at line 36 of file Telegram.h.

# message

int32 Telegram::message
protected

The message's code.

Definition at line 33 of file Telegram.h.

# receiver

void* Telegram::receiver
protected

The object that receives the message.

Definition at line 42 of file Telegram.h.

# sender

void* Telegram::sender
protected

The object that sends the message.

Definition at line 39 of file Telegram.h.


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