zeitgeist-sharp : Zeitgeist Namespace

BlacklistClient Class

The Zeitgeist engine maintains a list of event templates that is known as the blacklist.

public class BlacklistClient

Remarks

When inserting events via LogClient.InsertEvents they will be checked against the blacklist templates and if they match they will not be inserted in the log, and any matching monitors will not be signalled.

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

Members

See Also: Inherited members from object.

Public Constructors

The constructor for BlacklistClient

Public Methods

AddTemplate (string, Zeitgeist.Datamodel.Event)
Add a blacklist template to the engine to stop the matching events to be inserted. If the event was inserted successfully then TemplateAdded event is raised
GetTemplates () : Dictionary<string, Zeitgeist.Datamodel.Event>
Get the current blacklist templates.
RemoveTemplate (string)
Removes the blacklist from the engine if found. If the blacklist template was found and is removed then TemplateRemoved event is raised

Public Events

TemplateAdded Raised when a blacklist template is added When a new blacklist template is added to the engine, then this event is raised. The delegate Zeitgeist.BlacklistTemplateAddedHandler is used for handle the events. This handler has two argument: 'blacklistId' of type string and 'addedTemplate' of type Zeitgeist.Datamodel.Event
TemplateRemoved Raised when a blacklist template is removed When a new blacklist template is removed to the engine, then this event is raised. The delegate Zeitgeist.BlacklistTemplateRemovedHandler is used for handle the events. This handler has two argument: 'blacklistId' of type string and 'removedTemplate' of type Zeitgeist.Datamodel.Event

Member Details

BlacklistClient Constructor

The constructor for BlacklistClient

public BlacklistClient ()

Remarks

This constructor gets the DBus object for BlacklistClient which the object's methods use

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

AddTemplate Method

Add a blacklist template to the engine to stop the matching events to be inserted. If the event was inserted successfully then TemplateAdded event is raised

public void AddTemplate (string blacklistId, Zeitgeist.Datamodel.Event eventTemplate)

Parameters

blacklistId
The id of the blacklist template of the type string
eventTemplate
The actual event template of type Zeitgeist.Datamodel.Event

Remarks

The event template provided is used to match the event to be inserted. The Properties not set are treated as wildcards. Timestamp is not taken under consideration

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

GetTemplates Method

Get the current blacklist templates.

Returns

A dictionary of string as key and System.Collection.Generic.List<Zeitgeist.Datamodel.Event> as the Blacklist template

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

RemoveTemplate Method

Removes the blacklist from the engine if found. If the blacklist template was found and is removed then TemplateRemoved event is raised

public void RemoveTemplate (string blacklistId)

Parameters

blacklistId
The blacklist template id for the template string

Remarks

If the blacklist does not exist. No event is raised

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

TemplateAdded Event

Raised when a blacklist template is added When a new blacklist template is added to the engine, then this event is raised. The delegate Zeitgeist.BlacklistTemplateAddedHandler is used for handle the events. This handler has two argument: 'blacklistId' of type string and 'addedTemplate' of type Zeitgeist.Datamodel.Event

public event BlacklistTemplateAddedHandler TemplateAdded

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0

TemplateRemoved Event

Raised when a blacklist template is removed When a new blacklist template is removed to the engine, then this event is raised. The delegate Zeitgeist.BlacklistTemplateRemovedHandler is used for handle the events. This handler has two argument: 'blacklistId' of type string and 'removedTemplate' of type Zeitgeist.Datamodel.Event

public event BlacklistTemplateRemovedHandler TemplateRemoved

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: Zeitgeist
Assembly: zeitgeist-sharp (in zeitgeist-sharp.dll)
Assembly Versions: 0.8.0.0