Class EventFlags

Namespace

DxFeed.Graal.Net.Events

Assembly

DxFeed.Graal.Net.dll

Provides constants and utility methods for handling event flags.

public static class EventFlags

Inheritance

object

EventFlags

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

RemoveEvent

Indicates that the event with the corresponding index has to be removed.

public const int RemoveEvent = 2

Field Value

int

SnapShotMode

Is used to instruct dxFeed to use snapshot mode. It is intended to be used only for publishing to activate (if not yet activated) snapshot mode. The difference from SnapshotBegin flag is that SnapShotMode only switches on snapshot mode without starting snapshot synchronization protocol.

public const int SnapShotMode = 64

Field Value

int

SnapshotBegin

Indicates when the loading of a snapshot starts.

public const int SnapshotBegin = 4

Field Value

int

SnapshotEnd

SnapshotEnd or SnapshotSnip indicates the end of a snapshot. The difference between SnapshotEnd and SnapshotSnip is the following: SnapshotEnd indicates that the data source sent all the data pertaining to the subscription for the corresponding indexed event, while SnapshotSnip indicates that some limit on the amount of data was reached and while there still might be more data available, it will not be provided.

public const int SnapshotEnd = 8

Field Value

int

SnapshotSnip

SnapshotEnd or SnapshotSnip indicates the end of a snapshot. The difference between SnapshotEnd and SnapshotSnip is the following: SnapshotEnd indicates that the data source sent all the data pertaining to the subscription for the corresponding indexed event, while SnapshotSnip indicates that some limit on the amount of data was reached and while there still might be more data available, it will not be provided.

public const int SnapshotSnip = 16

Field Value

int

TxPending

Indicates a pending transactional update. When TxPending is 1, it means that an ongoing transaction update, that spans multiple events, is in process.

public const int TxPending = 1

Field Value

int

Methods

IsPending(IIndexedEvent)

Determines if the given event is in a pending state.

public static bool IsPending(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate a pending transaction, false otherwise.

IsRemove(IIndexedEvent)

Determines if the given event is marked for removal.

public static bool IsRemove(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate a remove action, false otherwise.

IsSnapshotBegin(IIndexedEvent)

Determines if the given event marks the beginning of a snapshot.

public static bool IsSnapshotBegin(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate the beginning of a snapshot, false otherwise.

IsSnapshotEnd(IIndexedEvent)

Determines if the given event marks the end of a snapshot.

public static bool IsSnapshotEnd(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate the end of a snapshot, false otherwise.

IsSnapshotEndOrSnip(IIndexedEvent)

Determines if the given event marks the end of a snapshot or a snapshot snip.

public static bool IsSnapshotEndOrSnip(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate the end or snip of a snapshot, false otherwise.

IsSnapshotSnip(IIndexedEvent)

Determines if the given event is marked as a snapshot snip.

public static bool IsSnapshotSnip(IIndexedEvent e)

Parameters

e IIndexedEvent

The event to be checked.

Returns

bool

true if the event flags indicate a snapshot snip, false otherwise.