com.solacesystems.solclientj.core.handle

Interface StatsSupport

All Known Subinterfaces:

FlowHandle, SessionHandle

public interface StatsSupport

The StatsSupport interface provides a common API for retrieving and clearing API statistics. Applications do not need to instantiate or extend objects with this interface. This interface is already included in all the solclientj interfaces where it is required:

• SessionHandle
• FlowHandle

Method Summary

Modifier and Type	Method and Description
int	clearStats() Clears statistics
void	getRxStats(long[] in_out_RxStats) Fill out all the available Receive statisticss in the given long[] array The array needs to be long enough (SolEnum.StatRx.getEnumCount()) to fit all the values shown in SolEnum.StatRx
void	getTxStats(long[] in_out_TxStats) Fill out all the available Transmit statistics in the given long[] array The array needs to be long enough (SolEnum.StatTx.getEnumCount()) to fit all the values shown in SolEnum.StatTx

Method Detail

clearStats

int clearStats()
        throws SolclientException

Clears statistics

Returns:

SolEnum.ReturnCode

Throws:

SolclientException

getTxStats

void getTxStats(long[] in_out_TxStats)
         throws SolclientException

Fill out all the available Transmit statistics in the given long[] array
The array needs to be long enough (SolEnum.StatTx.getEnumCount()) to fit all the values shown in SolEnum.StatTx

Parameters:

in_out_TxStats - - array to receive the statistics

Throws:

SolclientException

getRxStats

void getRxStats(long[] in_out_RxStats)
         throws SolclientException

Fill out all the available Receive statisticss in the given long[] array
The array needs to be long enough (SolEnum.StatRx.getEnumCount()) to fit all the values shown in SolEnum.StatRx

Parameters:

in_out_RxStats - - array to receive the statistics

Throws:

SolclientException