forwardInitiatorConnectionSettings Methods   Table of ContentScheduler Constructor forward
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.6.2_x64 (in FIXForge.NET.FIX.Scheduler-net-4.6.2_x64.dll) Version: 4.5.0.0 (4.5.0.0)
Syntax
C#
public class Scheduler : IDisposable

The Scheduler type exposes the following members.

Constructors
  NameDescription
Public methodScheduler()
Initializes Scheduler instance with default configuration.
Public methodScheduler(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
  NameDescription
Public propertyConnectionSettings
Collection of predefined session connection settings associated with unique names (ids) as it was specified in the configuration file.
Public propertyReconnectAttempts
Number of attempts to restore the telecommunication link.
Public propertyReconnectInterval
Time interval between the attempts to restore the telecommunication link (in seconds).
Public propertySchedules
Collection of predefined session schedules associated with unique names (ids) as it was specified in Scheduler's configuration file.
Public propertyTimeZone
This property allows to setup time zone used for schedules. Default value is TimeZoneInfo.Local.
Public propertyUtcTimeUsage Obsolete.
This property allows switching local time to UTC time usage
Top
Methods
  NameDescription
Public methodDispose
Performs graceful shutdown of scheduling services.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Performs graceful shutdown of scheduling services.
(Overrides Object.Finalize().)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRegister(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.
Public methodRegister(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.
Public methodRegister(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.
Public methodRegister(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.
Public methodSessionDesiredState
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregister
Removes session from automatic connection management services. If session were not registered before, does actually nothing.
Top
Events
  NameDescription
Public eventError
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.

Public eventInitiatorConnecting
Allows scheduler's users to be notified when initiator will try to connect to the next counterparty.
Public eventSessionLoggedOn
Allows scheduler's users to be notified about that scheduler performs session logon.
Public eventSessionLoggedOut
Allows scheduler's users to be notified about that scheduler performs session logout.
Public eventSessionLoggingOn
Allows scheduler's users to be notified about that scheduler wants to perform session logon.
Public eventSessionLoggingOut
Allows scheduler's users to be notified about that scheduler wants to perform session logout and control this process.
Public eventSessionResettedLocalSequenceNumbers
Allows scheduler's users to be notified about that scheduler reset session local sequence numbers.
Public eventSessionResettingLocalSequenceNumbers
Allows scheduler's users to be notified about that scheduler wants to reset session local sequence numbers.
Public eventWarning
Allows scheduler's users to be notified about warnings occurred while maintaining sessions connections.
Top
See Also