TplEvent

TplEvent — Abstract representation of a log event

Synopsis

                    TplEvent;
                    TplEventClass;
                    TplEventPriv;
gint64              tpl_event_get_timestamp             (TplEvent *self);
const gchar *       tpl_event_get_account_path          (TplEvent *self);
TpAccount *         tpl_event_get_account               (TplEvent *self);
TplEntity *         tpl_event_get_sender                (TplEvent *self);
TplEntity *         tpl_event_get_receiver              (TplEvent *self);
gboolean            tpl_event_equal                     (TplEvent *self,
                                                         TplEvent *data);

Object Hierarchy

  GObject
   +----TplEvent
         +----TplCallEvent
         +----TplTextEvent

Properties

  "account"                  TpAccount*            : Read / Write / Construct Only
  "account-path"             gchar*                : Read
  "channel-path"             gchar*                : Read / Write / Construct Only
  "receiver"                 TplEntity*            : Read / Write / Construct Only
  "sender"                   TplEntity*            : Read / Write / Construct Only
  "timestamp"                gint64                : Read / Write / Construct Only

Description

The TPLogger log event represents a generic log event, which will be specialized by subclasses of TplEvent.

Details

TplEvent

typedef struct _TplEvent TplEvent;

An object representing a generic log event.


TplEventClass

typedef struct _TplEventClass TplEventClass;


TplEventPriv

typedef struct _TplEventPriv TplEventPriv;


tpl_event_get_timestamp ()

gint64              tpl_event_get_timestamp             (TplEvent *self);

self :

a TplEvent

Returns :

the same timestamp as the "timestamp" property

tpl_event_get_account_path ()

const gchar *       tpl_event_get_account_path          (TplEvent *self);

self :

Returns :


tpl_event_get_account ()

TpAccount *         tpl_event_get_account               (TplEvent *self);

self :

a TplEvent

Returns :

the same account as the "account" property. [transfer none]

tpl_event_get_sender ()

TplEntity *         tpl_event_get_sender                (TplEvent *self);

self :

a TplEvent

Returns :

the same TplEntity as the "sender" property. [transfer none]

tpl_event_get_receiver ()

TplEntity *         tpl_event_get_receiver              (TplEvent *self);

self :

a TplEvent

Returns :

the same TplEntity as the "receiver" property. [transfer none]

tpl_event_equal ()

gboolean            tpl_event_equal                     (TplEvent *self,
                                                         TplEvent *data);

Checks if two instances of TplEvent represent the same data

self :

TplEvent subclass instance

data :

an instance of the same TplEvent subclass of self

Returns :

TRUE if data is the same type of self and they hold the same data, FALSE otherwise

Property Details

The "account" property

  "account"                  TpAccount*            : Read / Write / Construct Only

The TpAccount to which the log event is related.


The "account-path" property

  "account-path"             gchar*                : Read

The account path of the TpAccount to which the log event is related.

Default value: NULL


The "channel-path" property

  "channel-path"             gchar*                : Read / Write / Construct Only

The channel path of the TpChannel to which the log event is related.

Default value: NULL


The "receiver" property

  "receiver"                 TplEntity*            : Read / Write / Construct Only

TplEntity instance destination for the log event (may be NULL with some log stores).


The "sender" property

  "sender"                   TplEntity*            : Read / Write / Construct Only

TplEntity instance who originated the log event.


The "timestamp" property

  "timestamp"                gint64                : Read / Write / Construct Only

The timestamp (gint64) for the log event.

Default value: 0

See Also

TplTextEvent and other subclasses when they'll exist