Neuron®
The Neuron® is the basis for the creation of open and secure federated networks for smart societies.
Loading...
Searching...
No Matches
Waher.Events.Event Class Reference

Class representing an event. More...

Public Member Functions

 Event (DateTime Timestamp, EventType Type, string Message, string Object, string Actor, string EventId, EventLevel Level, string Facility, string Module, string StackTrace, params KeyValuePair< string, object >[] Tags)
 Class representing an event. More...
 
 Event (EventType Type, string Message, string Object, string Actor, string EventId, EventLevel Level, string Facility, string Module, string StackTrace, params KeyValuePair< string, object >[] Tags)
 Class representing an event. More...
 
 Event (EventType Type, Exception Exception, string Object, string Actor, string EventId, EventLevel Level, string Facility, string Module, params KeyValuePair< string, object >[] Tags)
 Class representing an event. More...
 
override string ToString ()
 
bool ShoudAvoid (IEventSink EventSink)
 If the event sink EventSink should be avoided when logging the event. More...
 
void Avoid (IEventSink EventSink)
 If the event sink EventSink should be avoided when logging the event. More...
 

Properties

DateTime Timestamp [get]
 Timestamp of event. More...
 
EventType Type [get]
 Type of event. More...
 
EventLevel Level [get]
 Event Level. More...
 
string Message [get]
 Free-text event message. More...
 
string Object [get]
 Object related to the event. More...
 
string Actor [get]
 Actor responsible for the action causing the event. More...
 
string EventId [get]
 Computer-readable Event ID identifying type of even. More...
 
string Facility [get]
 Facility can be either a facility in the network sense or in the system sense. More...
 
string Module [get]
 Module where the event is reported. More...
 
string StackTrace [get]
 Stack Trace of event. More...
 
KeyValuePair< string, object >[] Tags [get]
 Variable set of tags providing event-specific information. More...
 

Detailed Description

Class representing an event.

Definition at line 9 of file Event.cs.

Constructor & Destructor Documentation

◆ Event() [1/3]

Waher.Events.Event.Event ( DateTime  Timestamp,
EventType  Type,
string  Message,
string  Object,
string  Actor,
string  EventId,
EventLevel  Level,
string  Facility,
string  Module,
string  StackTrace,
params KeyValuePair< string, object >[]  Tags 
)

Class representing an event.

Parameters
TimestampTimestamp of event.
TypeEvent Type.
MessageFree-text event message.
ObjectObject related to the event.
ActorActor responsible for the action causing the event.
EventIdComputer-readable Event ID identifying type of even.
LevelEvent Level.
FacilityFacility can be either a facility in the network sense or in the system sense.
ModuleModule where the event is reported.
StackTraceStack Trace of event.
TagsVariable set of tags providing event-specific information.

Definition at line 38 of file Event.cs.

◆ Event() [2/3]

Waher.Events.Event.Event ( EventType  Type,
string  Message,
string  Object,
string  Actor,
string  EventId,
EventLevel  Level,
string  Facility,
string  Module,
string  StackTrace,
params KeyValuePair< string, object >[]  Tags 
)

Class representing an event.

Parameters
TypeEvent Type.
MessageFree-text event message.
ObjectObject related to the event.
ActorActor responsible for the action causing the event.
EventIdComputer-readable Event ID identifying type of even.
LevelEvent Level.
FacilityFacility can be either a facility in the network sense or in the system sense.
ModuleModule where the event is reported.
StackTraceStack Trace of event.
TagsVariable set of tags providing event-specific information.

Definition at line 67 of file Event.cs.

◆ Event() [3/3]

Waher.Events.Event.Event ( EventType  Type,
Exception  Exception,
string  Object,
string  Actor,
string  EventId,
EventLevel  Level,
string  Facility,
string  Module,
params KeyValuePair< string, object >[]  Tags 
)

Class representing an event.

Parameters
TypeEvent Type.
ExceptionException object.
ObjectObject related to the event.
ActorActor responsible for the action causing the event.
EventIdComputer-readable Event ID identifying type of even.
LevelEvent Level.
FacilityFacility can be either a facility in the network sense or in the system sense.
ModuleModule where the event is reported.
TagsVariable set of tags providing event-specific information.

Definition at line 95 of file Event.cs.

Member Function Documentation

◆ Avoid()

void Waher.Events.Event.Avoid ( IEventSink  EventSink)

If the event sink EventSink should be avoided when logging the event.

Parameters
EventSinkEvent sink
Returns
If the event sink should be avoided.

Definition at line 189 of file Event.cs.

◆ ShoudAvoid()

bool Waher.Events.Event.ShoudAvoid ( IEventSink  EventSink)

If the event sink EventSink should be avoided when logging the event.

Parameters
EventSinkEvent sink
Returns
If the event sink should be avoided.

Definition at line 179 of file Event.cs.

◆ ToString()

override string Waher.Events.Event.ToString ( )

Definition at line 169 of file Event.cs.

Property Documentation

◆ Actor

string Waher.Events.Event.Actor
get

Actor responsible for the action causing the event.

Definition at line 141 of file Event.cs.

◆ EventId

string Waher.Events.Event.EventId
get

Computer-readable Event ID identifying type of even.

Definition at line 146 of file Event.cs.

◆ Facility

string Waher.Events.Event.Facility
get

Facility can be either a facility in the network sense or in the system sense.

Definition at line 151 of file Event.cs.

◆ Level

EventLevel Waher.Events.Event.Level
get

Event Level.

Definition at line 126 of file Event.cs.

◆ Message

string Waher.Events.Event.Message
get

Free-text event message.

Definition at line 131 of file Event.cs.

◆ Module

string Waher.Events.Event.Module
get

Module where the event is reported.

Definition at line 156 of file Event.cs.

◆ Object

string Waher.Events.Event.Object
get

Object related to the event.

Definition at line 136 of file Event.cs.

◆ StackTrace

string Waher.Events.Event.StackTrace
get

Stack Trace of event.

Definition at line 161 of file Event.cs.

◆ Tags

KeyValuePair<string, object> [] Waher.Events.Event.Tags
get

Variable set of tags providing event-specific information.

Definition at line 166 of file Event.cs.

◆ Timestamp

DateTime Waher.Events.Event.Timestamp
get

Timestamp of event.

Definition at line 116 of file Event.cs.

◆ Type

EventType Waher.Events.Event.Type
get

Type of event.

Definition at line 121 of file Event.cs.


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