Class SessionScheduler

Session Scheduler.

Inheritance
object
SessionScheduler
Implements
Inherited Members
Namespace: OnixS.Cme.ILink3.Schedule
Assembly: OnixS.Cme.ILink3.dll
Syntax
public class SessionScheduler : IDisposable

Constructors

SessionScheduler(LogFactory)

Constructor.

Declaration
public SessionScheduler(LogFactory logManager = null)
Parameters
Type Name Description
LogFactory logManager

SessionScheduler(string, LogFactory)

Constructor.

Declaration
public SessionScheduler(string configFile, LogFactory logManager = null)
Parameters
Type Name Description
string configFile
LogFactory logManager

Properties

AffinitySet

The CPU affinity for the Scheduler service thread.

Declaration
public uint[] AffinitySet { get; set; }
Property Value
Type Description
uint[]

ReconnectAttempts

The number of logon attempts in case of a logon failure.

Declaration
public int ReconnectAttempts { get; set; }
Property Value
Type Description
int

ReconnectInterval

The time interval between the logon attempts in case of a logon failure (in seconds).

Declaration
public int ReconnectInterval { get; set; }
Property Value
Type Description
int

UtcTimeUsage

The UTC usage.

Declaration
public bool UtcTimeUsage { get; set; }
Property Value
Type Description
bool

Methods

Add(Session, SessionSchedule, SessionConnectionSettings)

Adds the session to the automatic connection management.

  • If the session is being added during the active time frame, it will be connected immediately.
  • If the session is being registered during the inactive time frame and is in the active state, it will be disconnected.
  • If the session is already registered, an exception will be thrown.
Declaration
public SessionScheduler Add(Session session, SessionSchedule schedule, SessionConnectionSettings connectivity)
Parameters
Type Name Description
Session session
SessionSchedule schedule
SessionConnectionSettings connectivity
Returns
Type Description
SessionScheduler

Add(Session, string, string)

Adds the session to the automatic connection management.

  • If the session is being added during the active time frame, it will be connected immediately.
  • If the session is being registered during the inactive time frame and is in the active state, it will be disconnected.
  • If the session is already registered, an exception will be thrown.
Declaration
public SessionScheduler Add(Session session, string scheduleId, string connectivityId)
Parameters
Type Name Description
Session session
string scheduleId
string connectivityId
Returns
Type Description
SessionScheduler

Contains(Session)

Checks whether the session is registered under the scheduler.

Declaration
public bool Contains(Session session)
Parameters
Type Name Description
Session session
Returns
Type Description
bool

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

Dispose(bool)

Declaration
protected void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

~SessionScheduler()

Declaration
protected ~SessionScheduler()

FindConnectionSetting(string)

Looks for the predefined session connection settings associated with the given id that was specified in Scheduler's configuration file.

Declaration
public SessionConnectionSettings FindConnectionSetting(string presetId)
Parameters
Type Name Description
string presetId
Returns
Type Description
SessionConnectionSettings

FindSchedule(string)

Looks for the predefined session schedule associated with the given id that was specified in Scheduler's configuration file.

Declaration
public SessionSchedule FindSchedule(string presetId)
Parameters
Type Name Description
string presetId
Returns
Type Description
SessionSchedule

Remove(Session)

Removes the session from the automatic connection management services.

Declaration
public SessionScheduler Remove(Session session)
Parameters
Type Name Description
Session session
Returns
Type Description
SessionScheduler

Events

SchedulerLoggingOut

Session log out condition is detected.

Declaration
public event EventHandler<SessionSchedulerLoggingOutEventArgs> SchedulerLoggingOut
Event Type
Type Description
EventHandler<SessionSchedulerLoggingOutEventArgs>

SessionSchedulerError

Error condition is detected.

Declaration
public event EventHandler<SessionSchedulerErrorEventArgs> SessionSchedulerError
Event Type
Type Description
EventHandler<SessionSchedulerErrorEventArgs>

SessionSchedulerWarning

Warning condition is detected.

Declaration
public event EventHandler<SessionSchedulerWarningEventArgs> SessionSchedulerWarning
Event Type
Type Description
EventHandler<SessionSchedulerWarningEventArgs>

Implements