com.bmc.arsys.apitransport.session

Class ApiRpcTimeOutBase

java.lang.Object

com.bmc.arsys.apitransport.session.ApiRpcTimeOutBase

All Implemented Interfaces:

ApiPropertyI, ApiRpcTimeOutI

Direct Known Subclasses:

ArRpcTimeOut

public class ApiRpcTimeOutBase
extends Object
implements ApiRpcTimeOutI, ApiPropertyI

Contains TimeOut settings for individual API Rpc call. All of the timeOut setting and their corresponding error code are individually coded in ar.c and arb.c for each API call. We are here to put them together and assign to Java API call automatically.

Constructor Summary

Constructors

Constructor and Description
ApiRpcTimeOutBase()

Method Summary

Modifier and Type	Method and Description
void	addTimeOutLong(int rpcCallNum, int errorCode) for api procedure need rpc timeoutLong setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT & ARErrorBase.AR_ERROR_RPC_TIMEOUT_2
void	addTimeOutNormal(int rpcCallNum, int errorCode) for api procedure need rpc timeoutNormal setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT & ARErrorBase.AR_ERROR_RPC_TIMEOUT_2
void	addTimeOutXLong(int rpcCallNum, int errorCode) for api procedure need rpc timeoutXLong setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT, ARErrorBase.AR_ERROR_RPC_TIMEOUT_2 & ARErrorBase.AR_ERROR_RPC_TIMEOUT_3
int	getErrorCode(int procedureNumber) get the time out Ar error code for particular procedure number
int	getTimeOut(int procedureNumber) get the time out setting for particular procedure number

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiRpcTimeOutBase

public ApiRpcTimeOutBase()

Method Detail

getTimeOut

public int getTimeOut(int procedureNumber)

get the time out setting for particular procedure number

Parameters:

procedureNumber -

Returns:

getErrorCode

public int getErrorCode(int procedureNumber)

get the time out Ar error code for particular procedure number

Parameters:

procedureNumber -

Returns:

addTimeOutLong

public void addTimeOutLong(int rpcCallNum,
                           int errorCode)

Description copied from interface: ApiRpcTimeOutI

for api procedure need rpc timeoutLong setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT & ARErrorBase.AR_ERROR_RPC_TIMEOUT_2

Specified by:

addTimeOutLong in interface ApiRpcTimeOutI

addTimeOutNormal

public void addTimeOutNormal(int rpcCallNum,
                             int errorCode)

Description copied from interface: ApiRpcTimeOutI

for api procedure need rpc timeoutNormal setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT & ARErrorBase.AR_ERROR_RPC_TIMEOUT_2

Specified by:

addTimeOutNormal in interface ApiRpcTimeOutI

addTimeOutXLong

public void addTimeOutXLong(int rpcCallNum,
                            int errorCode)

Description copied from interface: ApiRpcTimeOutI

for api procedure need rpc timeoutXLong setting corresponding error code: ARErrorBase.AR_ERROR_RPC_TIMEOUT, ARErrorBase.AR_ERROR_RPC_TIMEOUT_2 & ARErrorBase.AR_ERROR_RPC_TIMEOUT_3

Specified by:

addTimeOutXLong in interface ApiRpcTimeOutI