PoolItem class
Returns information about a remote pool within the Pool Manager. Also allows for controlling the pool with regard to starting and stopping it.
Prototype
public class PoolItem
Member of HostFront.EAI.PoolManager
Related Links
Methods
Properties
General class library reference (Parent Topic)
Methods
The following methods are associated with the PoolItem class.
ControlPool
Submits an action to the remote pool described by the PoolAction type.
Prototype
public System.Public System.Booleanean ControlPool (HostFront.EAI.PoolManager.ControlAction action)
Member of HostFront.Pool.PoolItem
Parameters
Action: The action to perform (see ControlAction Enumerator).
Return
Returns whether the control action was successful.
New
This is for internal use only.
ValidPoolActions
Determines the valid actions that can be performed given the status of the remote pool.
Prototype
public static HostFront.EAI.PoolManager.ControlAction ValidPoolActions (HostFront.EAI.PoolManager.PoolStatus status)
Member of HostFront.Pool.PoolItem
Parameters
Status: The status of the remote pool.
Return
A valid action that can be performed.
Related Links
PoolItem class (Parent Topic)
Properties
The following properties are associated with the PoolItem class.
AvailableConnections
Returns the number of available or free sessions.
Prototype
public int AvailableConnections [ get, set ]
Member of HostFront.Pool.PoolItem
DefaultLogin
The default has host login.
Prototype
public HostFront.Pool.PoolLogin DefaultLogin [ get, set ]
Member of HostFront.Pool.PoolItem
Emulation
The emulation used for the pool connections. Used through the UI of the Pool Explorer (Pool Properties).
Prototype
public
Member of HostFront.Pool.PoolItem
Parameters
Status:
Return
EncryptInputProfile
When this value is set, the configurable values to the Input Params in the Profile tag in the Pool Manager's profile PoolManagerService.exe.config file are encrypted and becomes unreadable. This hides some sensitive input field values, like SystemID and Password. Refer to PoolProfile.Input Parameter class for more information.
Prototype
public EncryptInputProfile [ get, set ]
Member of HostFront.Pool.PoolItem
Logins
The list of host logins to be used each for one session.
Prototype
public HostFront.Block.HFNavigationEmulation Emulation [ get, set ]
Member of HostFront.Pool.PoolItem
MailNotification
Enables the mail notification feature.
Prototype
public MailNotification [ get]
Member of HostFront.Pool.PoolItem
OneLogin
Does this login use only one login for all sessions (does the pool use one HostFront account for all its sessions or multiple accounts)?
Prototype
public bool OneLogin [ get, set ]
Member of HostFront.Pool.PoolItem
Password
The password that secures access to the Pool Manager Service through the Pool Explorer UI.
Prototype
public string Password [ get, set ]
Member of HostFront.Pool.PoolItem
Poll
Returns the polling time of the pool in milliseconds.
Prototype
public int Poll [ get, set ]
Member of HostFront.Pool.PoolItem
PoolName
Returns the name of the remote pool.
Prototype
public string Poolname [ get, set ]
Member of HostFront.Pool.PoolItem
PoolSize
Returns the initial size of the pool.
Prototype
public int PoolSize [ get, set ]
Member of HostFront.Pool.PoolItem
Status
Returns the status of the remote pool.
Prototype
public HostFront.EAI.PoolManager.PoolStatus Status [ get, set ]
Member of HostFront.Pool.PoolItem
Port
The listening port of the HostFront Cluster Service to which the Pool Manager Service will connect. Used through the UI of the Pool Explorer (Pool Properties).
Prototype
public int Port [ get, set ]
Member of HostFront.Pool.PoolItem
Profiles
Refers to the list of profiles.
Prototype
public
Member of HostFront.Pool.PoolItem
SerialStart
Controls whether the sessions in a pool will start one after the other (serially) or in one shot (in parallel). Used through the UI of the Pool Explorer (Pool Properties).
Prototype
public bool SerialStart [ get, set ]
Member of HostFront.Pool.PoolItem
ServerIP
The IP of the HostFront cluster entry point (to which the Pool Manager Service will sign on and connect to get the sessions.
Prototype
public string ServerIP [ get, set ]
Member of HostFront.Pool.PoolItem
StartAtStartUP
Defines whether the pool starts automatically with the Pool Manager Service or not.
Prototype
public bool StartAtStartup [ get, set ]
Member of HostFront.Pool.PoolItem
Trace
Used to enable or disable tracing.
Prototype
public bool Trace [ get, set ]
Member of HostFront.Pool.PoolItem
UseCluster
Setting this to TRUE informs the Pool Manager Service that it will connect to HostFront Server version 4 or later that supports the cluster architecture. If set to FALSE, it means the Pool Manager Service will try to connect to a HostFront Server version 3.5.x.
Prototype
public bool UseCluster [ get, set ]
Member of HostFront.Pool.PoolItem
Related Links
PoolItem class (Parent Topic)