Class SessionSchedule

Defines activity time frames for the session. Also provides the ability to define sequence number reset policy for the session.

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)

Initializes session schedule according to given parameters.

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

Session sequence number reset policy must correspond to the session duration time. In particular, if session continues entire week it's not possible to request scheduler to reset session sequence number on daily basis.

Declaration

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

Parameters

Type	Name	Description
DayOfWeek	firstDay	Defines first day of activity week for the session.
DayOfWeek	lastDay	Defines last day of activity week for the session.
TimeSpan	logonTime	Defines time of logon for session for each activity day if session duration is single day. If session must continue entire week, defines time of logon performed on the first day of activity week.
TimeSpan	logoutTime	Defines time of logout for session for each activity day if session duration is single day. If session must continue entire week, defines time of logout performed on the last day of activity week.
SessionDuration	sessionDuration	Defines whether session continues entire week or activity time frame is limited for single day.
SequenceNumberResetPolicy	seqNumberResetPolicy	Defines session sequence number reset policy.

Properties

FirstDay

Defines first day of activity week for the session.

Declaration

public DayOfWeek FirstDay { get; }

Property Value

Type	Description
DayOfWeek

LastDay

Defines last day of activity week for the session.

Declaration

public DayOfWeek LastDay { get; }

Property Value

Type	Description
DayOfWeek

LogonTimes

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

Declaration

public IList<TimeSpan> LogonTimes { get; }

Property Value

Type	Description
IList<TimeSpan>

LogoutTimes

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

Declaration

public IList<TimeSpan> LogoutTimes { get; }

Property Value

Type	Description
IList<TimeSpan>

SequenceNumberResetPolicy

Defines session sequence number reset policy.

Declaration

public SequenceNumberResetPolicy SequenceNumberResetPolicy { get; }

Property Value

Type	Description
SequenceNumberResetPolicy

SessionDuration

Defines whether session continues entire week or activity time frame is limited for single day.

Declaration

public SessionDuration SessionDuration { get; }

Property Value

Type	Description
SessionDuration

Methods

ToString()

Convert object to string representation.

Declaration

public override string ToString()

Returns

Type	Description
String	String representation of object.

Overrides

Object.ToString()