Scheduler Class : OnixS .NET Framework FIX Engine

Scheduler Class

Scheduler performs session connection maintenance according to the specified schedule for session activities. It monitors whenever criteria to log a particular session either on or off is triggered and automatically executes appropriate action.

Remarks

Scheduler implements IDisposable interface to provide users with the ability to shutdown scheduling services by single action. Supporting IDisposable interface also gives the opportunity to combine Scheduler with built-in language statements like using statement in C# and make scheduling more error-resistant.

Inheritance Hierarchy

System.Object
FIXForge.NET.FIX.Scheduling.Scheduler

Namespace: FIXForge.NET.FIX.Scheduling
Assembly: FIXForge.NET.FIX.Scheduler-net-4.8_x64 (in FIXForge.NET.FIX.Scheduler-net-4.8_x64.dll) Version: 4.12.0.0 (4.12.0.0)

Syntax

Copy

public class Scheduler : IDisposable

The Scheduler type exposes the following members.

Constructors

	Name	Description
	Scheduler()	Initializes Scheduler instance with default configuration.
	Scheduler(String)	Initializes Scheduler instance according to the options specified in given configuration file. In particular, Scheduler extracts from configuration a set of predefined session schedules and connection settings later available through Schedules and ConnectionSettings properties.

Top

Properties

	Name	Description
	ConnectionSettings	Collection of predefined session connection settings associated with unique names (ids) as it was specified in the configuration file.
	ReconnectAttempts	Number of attempts to restore the FIX connection.
	ReconnectInterval	Time interval between the attempts to restore the FIX connection (in seconds).
	Schedules	Collection of predefined session schedules associated with unique names (ids) as it was specified in Scheduler's configuration file.
	TimeZone	This property allows to setup time zone used for schedules. Default value is TimeZoneInfo.Local.
	UtcTimeUsage	Obsolete. This property allows switching local time to UTC time usage

Top

Methods

	Name	Description
	Dispose	Performs graceful shutdown of scheduling services.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Performs graceful shutdown of scheduling services. (Overrides Object.Finalize().)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Register(Session, SessionSchedule, SessionConnectionSettings)	Adds session to automatic connection management. If session is being added during active time frame, it will be connected immediately. If session is being registered during inactive time frame and has active state, it will be disconnected. If session already registered, exception will be thrown.
	Register(Session, SessionSchedule[], SessionConnectionSettings)	Adds session to automatic connection management. If session is being added during active time frame, it will be connected immediately. If session is being registered during inactive time frame and has active state, it will be disconnected. If session already registered, exception will be thrown.
	Register(Session, String, String)	Adds session to automatic connection management. Remarks If session is being added during active time frame, it will be connected immediately. If session is being registered during inactive time frame and has active state, it will be disconnected. If session already registered, exception will be thrown.
	Register(Session, String[], String)	Adds session to automatic connection management. Remarks If session is being added during active time frame, it will be connected immediately. If session is being registered during inactive time frame and has active state, it will be disconnected. If session already registered, exception will be thrown.
	SessionDesiredState(Session)	Returns a desired state (ACTIVE or DISCONNECTED), for the current time point, of the given session in accordance with the registered, for this session, schedule.
	SessionDesiredState(Session, DateTime)	Returns a desired state (ACTIVE or DISCONNECTED), for the given time point, of the given session in accordance with the registered, for this session, schedule.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes session from automatic connection management services. If session were not registered before, exception will be thrown.

Top

Events

	Name	Description
	Error	Allows scheduler's users to be notified about errors occurred while maintaining sessions connections. Remarks Scheduler doesn't notify about all errors occurred while maintaining session activity. For example, if session was not connected within first time as well as connection was dropped, scheduler will not fire error event immediately. Instead, it will perform reconnection attempts according to FIX Engine settings. Only if all attempts will fail, scheduler will fire error event. Once scheduler notified about inability to connect certain session, it will not perform more attempts to bring session to connected state until next logon (activity) time.
	InitiatorConnecting	Allows scheduler's users to be notified when initiator will try to connect to the next counterparty.
	SessionLoggedOn	Allows scheduler's users to be notified about that scheduler performs session logon.
	SessionLoggedOut	Allows scheduler's users to be notified about that scheduler performs session logout.
	SessionLoggingOn	Allows scheduler's users to be notified about that scheduler wants to perform session logon.
	SessionLoggingOut	Allows scheduler's users to be notified about that scheduler wants to perform session logout and control this process.
	SessionResettedLocalSequenceNumbers	Allows scheduler's users to be notified about that scheduler reset session local sequence numbers.
	SessionResettingLocalSequenceNumbers	Allows scheduler's users to be notified about that scheduler wants to reset session local sequence numbers.
	Warning	Allows scheduler's users to be notified about warnings occurred while maintaining sessions connections.

Top

Reference

FIXForge.NET.FIX.Scheduling Namespace