Open pool for connections to MVSP server
Namespace: rocketsoftware.MVSP
Assembly: RocketMVSP (in RocketMVSP.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function OpenPool( _ ByVal sHostName As String, _ ByVal nHostPort As Integer, _ ByVal sUserName As String, _ ByVal sUserPassword As String, _ ByVal sAcctName As String, _ ByVal sAcctPassword As String, _ Optional ByVal bSslConnect As Boolean = False, _ Optional ByVal nMinCapacity As Integer = 0, _ Optional ByVal nMaxCapacity As Integer = 0 _ ) As Boolean |
| C# |
|---|
| public bool OpenPool( string sHostName, int nHostPort, string sUserName, string sUserPassword, string sAcctName, string sAcctPassword, [OptionalAttribute] bool bSslConnect, [OptionalAttribute] int nMinCapacity, [OptionalAttribute] int nMaxCapacity ) |
| C++ |
|---|
| public: bool OpenPool( String sHostName, int nHostPort, String sUserName, String sUserPassword, String sAcctName, String sAcctPassword, [OptionalAttribute] bool bSslConnect, [OptionalAttribute] int nMinCapacity, [OptionalAttribute] int nMaxCapacity ) sealed |
| J# |
|---|
| public bool OpenPool( string sHostName, int nHostPort, string sUserName, string sUserPassword, string sAcctName, string sAcctPassword, /** @attribute OptionalAttribute() */ bool bSslConnect, /** @attribute OptionalAttribute() */ int nMinCapacity, /** @attribute OptionalAttribute() */ int nMaxCapacity ) |
| JScript |
|---|
| public
function OpenPool( sHostName : String, nHostPort : int, sUserName : String, sUserPassword : String, sAcctName : String, sAcctPassword : String, OptionalAttribute bSslConnect : bool, OptionalAttribute nMinCapacity : int, OptionalAttribute nMaxCapacity : int ) : bool |
Parameters
- sHostName
- String containing the hostname or TCP/IP address to connect to MVSP server
- nHostPort
- Integer containing the TCP/IP socket that the host server is listening on
- sUserName
- String containing the user name that you wish to connect as. The username must be an enabled MVSP user.
- sUserPassword
- String containing the password for the supplied username
- sAcctName
- String containing the account name of account to log to
- sAcctPassword
- String containing the password for the supplied account name
- bSslConnect
- Boolean indicating use of SSL connection (true) or telnet connection (false)
- nMinCapacity
- Integer containing the minimum number of connections to MVSP server in pool
- nMaxCapacity
- Integer containing the maximum number of connections to MVSP server in pool
Return Value
True if pool successfully opened
Remarks
Sets StatusMessage and StatusCode properties
Can only open the pool when it is not already opened.
When opening the pool, we specify the parameters for connecting the MVSP server.
All connections in the pool are connected to the same MVSP server.
If a minimum capacity is specified, the minimum number of connections to the MVSP server will be automatically established.
If no minimum capacity is specified, connecting to the MVSP server doesn't occur when opening the pool, but when calling the GetConnection method.