Sage Modeling and Simulation Library

SimpleServer Members

The SimpleServer type exposes the following members.

Constructors


  Name Description
Public method SimpleServer

Methods


  Name Description
Public method AddPort(IPort)
Registers a port with this IPortOwner
Public method AddPort(String)
Adds a port to this object's port set in the specified role or channel.
Public method AddPort(String, Guid)
Adds a port to this object's port set in the specified role or channel.
Public method ClearPorts
Unregisters all ports that this IPortOwner knows to be its own.
Public method Equals(System.Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method InitializeIdentity
Initialize the identity of this model object, once.
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method PlaceInService()()()()
Places the server in service immediately. The server will try immediately to pull and service a service object from its input port.
Public method PlaceInServiceAt
Waits until a specified time, then places the server in service. Can be done directly in code through the PlaceInService() API and an executive event with handler.
Protected method PrepareToServe
This method is called either when an in-process service completes, or when a new service object shows up at the entry point of an idle server.
Public method RemoveFromService()()()()
Removes this server from service immediately. The server will complete servicing its current service item, and then accept no more items.
Public method RemoveFromServiceAt
Removes the server from service at a specified time. The server will complete servicing its current service item, and then accept no more items.
Public method RemovePort
Unregisters a port from this IPortOwner.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties


  Name Description
Public property Description
A description of this SimpleServer.
Public property Guid
Public property Input
Public property Model
The model that owns this object, or from which this object gets time, etc. data.
Public property Name
Public property Output
Public property Periodicity
The periodicity of the server.
Public property Ports
The public property that is the PortSet this IPortOwner owns.
Public property SupportedChannelInfo
Gets the names of supported port channels.

Events


  Name Description
Public event ServiceBeginning
Fires when the server begins servicing an object.
Public event ServiceCompleted
Fires when the server completes servicing an object.