Class SessionSchedule

Describes the session lifetime and the sequence number reset policy.

Inheritance

object

SessionSchedule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: OnixS.Fix.Scheduling

Assembly: OnixS.Fix.Engine.dll

Syntax

public class SessionSchedule

Constructors

SessionSchedule(DayOfWeek, DayOfWeek, TimeSpan, TimeSpan, SessionDuration, SequenceNumberResetPolicy)

Constructor.

If the session duration is a single day, then login and logout are performed each day from the first day of the week till the last day of the week. If session duration is defined as the entire week, session login occurs on the first day of the week, and the corresponding logout is performed on the last day of the week.

The session sequence number reset policy must correspond to the session duration time. For example, if the session continues the entire week, requesting that the scheduler reset the session sequence number daily is impossible.

Declaration

public SessionSchedule(DayOfWeek firstDay, DayOfWeek lastDay, TimeSpan logonTime, TimeSpan logoutTime, SessionDuration duration, SequenceNumberResetPolicy seqNumberResetPolicy)

Parameters

Type	Name	Description
DayOfWeek	firstDay	The first active day of the week
DayOfWeek	lastDay	The last active day of the week
TimeSpan	logonTime	The logon time
TimeSpan	logoutTime	The logout time
SessionDuration	duration	The session lifetime
SequenceNumberResetPolicy	seqNumberResetPolicy	The session sequence number reset policy

Properties

FirstDay

The first active day.

Declaration

public DayOfWeek FirstDay { get; }

Property Value

Type	Description
DayOfWeek

LastDay

The last active day.

Declaration

public DayOfWeek LastDay { get; }

Property Value

Type	Description
DayOfWeek

LogonTimes

Returns the logon time for the session for each day of the week. If login is not performed on a particular day, the value of the entry correspondent for that day is equal to MinValue.

Declaration

public IList<TimeSpan> LogonTimes { get; }

Property Value

Type	Description
IList<TimeSpan>

LogoutTimes

Returns the logout time for the session for each day of the week. If logout is not performed on a particular day, the value of the entry correspondent for that day is equal to MinValue.

Declaration

public IList<TimeSpan> LogoutTimes { get; }

Property Value

Type	Description
IList<TimeSpan>

SequenceNumberResetPolicy

The session sequence number reset policy.

Declaration

public SequenceNumberResetPolicy SequenceNumberResetPolicy { get; }

Property Value

Type	Description
SequenceNumberResetPolicy

SessionDuration

Session lifetime.

Declaration

public SessionDuration SessionDuration { get; }

Property Value

Type	Description
SessionDuration

Methods

ToString()

Returns the string representation of the object so that it is suitable for display.

Declaration

public override string ToString()

Returns

Type	Description
string	String representation of the object.

Overrides

object.ToString()