Search Results for

Show / Hide Table of Contents

# Class EventBase

Base event implementation.

##### Inheritance

System.Object
EventBase
CacheEvent
CacheQueryExecutedEvent
CacheQueryReadEvent
CacheRebalancingEvent
CheckpointEvent
DiscoveryEvent
JobEvent
TaskEvent

##### Implements

IEvent
IEquatable<EventBase>

###### Namespace: Apache.Ignite.Core.Events

###### Assembly: Apache.Ignite.Core.dll

##### Syntax

    public abstract class EventBase : object, IEvent, IEquatable<EventBase>

### Constructors

#### EventBase(IBinaryRawReader)

Initializes a new instance of the EventBase class.

##### Declaration

    protected EventBase(IBinaryRawReader r)

##### Parameters

Type | Name | Description
--- | --- | ---
IBinaryRawReader | r | The reader to read data from.

### Properties

#### Id

Gets globally unique ID of this event.

##### Declaration

    public IgniteGuid Id { get; }

##### Property Value

Type | Description
--- | ---
IgniteGuid |

#### LocalOrder

Gets locally unique ID that is atomically incremented for each event. Unlike global Id this local ID can be used for ordering events on this node.

Note that for performance considerations Ignite doesn't order events globally.

##### Declaration

    public long LocalOrder { get; }

##### Property Value

Type | Description
--- | ---
System.Int64 |

#### Message

Gets optional message for this event.

##### Declaration

    public string Message { get; }

##### Property Value

Type | Description
--- | ---
System.String |

#### Name

Gets name of this event.

##### Declaration

    public string Name { get; }

##### Property Value

Type | Description
--- | ---
System.String |

#### Node

Node where event occurred and was recorded.

##### Declaration

    public IClusterNode Node { get; }

##### Property Value

Type | Description
--- | ---
IClusterNode |

#### Timestamp

Gets event timestamp. Timestamp is local to the node on which this event was produced. Note that more than one event can be generated with the same timestamp. For ordering purposes use LocalOrder instead.

##### Declaration

    public DateTime Timestamp { get; }

##### Property Value

Type | Description
--- | ---
DateTime |

#### Type

Gets type of this event. All system event types are defined in EventType

##### Declaration

    public int Type { get; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

### Methods

#### Equals(EventBase)

Determines whether the specified object is equal to this instance.

##### Declaration

    public bool Equals(EventBase other)

##### Parameters

Type | Name | Description
--- | --- | ---
EventBase | other | The object to compare with this instance.

##### Returns

Type | Description
--- | ---
System.Boolean | `true` if the specified object is equal to this instance; otherwise, `false`.

#### Equals(Object)

Determines whether the specified object is equal to this instance.

##### Declaration

    public override bool Equals(object obj)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Object | obj | The object to compare with this instance.

##### Returns

Type | Description
--- | ---
System.Boolean | `true` if the specified object is equal to this instance; otherwise, `false`.

#### GetHashCode()

Returns a hash code for this instance.

##### Declaration

    public override int GetHashCode()

##### Returns

Type | Description
--- | ---
System.Int32 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

#### ReadNode(IBinaryRawReader)

Reads a node from stream.

##### Declaration

    protected static IClusterNode ReadNode(IBinaryRawReader reader)

##### Parameters

Type | Name | Description
--- | --- | ---
IBinaryRawReader | reader | Reader.

##### Returns

Type | Description
--- | ---
IClusterNode | Node or null.

#### ToShortString()

Gets shortened version of ToString result.

##### Declaration

    public virtual string ToShortString()

##### Returns

Type | Description
--- | ---
System.String |

#### ToString()

Returns a that represents this instance.

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
System.String | A that represents this instance.

### Implements

IEvent
IEquatable<>