VMware GemFire Java API Reference
Package org.apache.geode.management
Interface GatewayReceiverMXBean
-
public interface GatewayReceiverMXBeanMBean that provides access to information and management functionality for aGatewayReceiver.- Since:
- GemFire 7.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description longgetAverageBatchProcessingTime()Returns the average batch processing time (in milliseconds).java.lang.StringgetBindAddress()Returns the bind address on the host.intgetClientConnectionCount()Returns the number of sockets accepted and used for client to server messaging.java.lang.String[]getConnectedGatewaySenders()Returns a list of the host and port information for gateway senders connected to this gateway receiver.doublegetConnectionLoad()Returns the load from client to server connections as reported by the load probe installed in this server.intgetConnectionThreads()Returns the current number of threads handling a client connection.floatgetCreateRequestsRate()Returns the rate of create requests received.floatgetDestroyRequestsRate()Returns the rate of destroy requests received.intgetDuplicateBatchesReceived()Returns the number of duplicate batches which have been received.intgetEndPort()Returns the configured end port.floatgetEventsReceivedRate()Returns the instantaneous rate of events received.java.lang.String[]getGatewayTransportFilters()Returns a list of names for the transport filters in use.longgetGetRequestAvgLatency()Returns the average get request latency.floatgetGetRequestRate()Returns the rate of get requests.default java.lang.StringgetHostnameForSenders()Returns the hostname for receiver for the remote senders to connect to.doublegetLoadPerConnection()Returns the estimate of how much load is added for each new connection as reported by the load probe installed in this server.doublegetLoadPerQueue()Returns the estimate of how much load is added for each new queue as reported by the load probe installed in this server.intgetMaximumTimeBetweenPings()Returns the maximum amount of time between client pings.intgetNumGateways()Returns the number of client virtual machines connected and acting as a gateway.intgetOutoforderBatchesReceived()Returns the number of batches which have been received out of order.intgetPort()Returns the port the receiver is listening on.longgetPutRequestAvgLatency()Returns the average put request latency.floatgetPutRequestRate()Returns the rate of put requests.doublegetQueueLoad()Returns the load from queues as reported by the load probe installed in this server.intgetSocketBufferSize()Returns the configured buffer size of the socket connection.intgetStartPort()Returns the configured start port.intgetThreadQueueSize()Returns the current number of connections waiting for a thread to start processing their message.intgetTotalConnectionsTimedOut()Returns the total number of client connections that timed out and were closed.intgetTotalFailedConnectionAttempts()Returns the total number of client connection requests that failed.longgetTotalReceivedBytes()Returns the total number of bytes received from clients.longgetTotalSentBytes()Returns the total number of bytes sent to clients.floatgetUpdateRequestsRate()Returns the rate of update requests received.booleanisRunning()Returns whether the receiver is in running state.voidstart()Starts the gateway receiver.voidstop()Stops the gateway receiver.
-
-
-
Method Detail
-
getPort
int getPort()
Returns the port the receiver is listening on.- Returns:
- the port the receiver is listening on
-
getSocketBufferSize
int getSocketBufferSize()
Returns the configured buffer size of the socket connection.- Returns:
- the configured buffer size of the socket connection
-
getBindAddress
java.lang.String getBindAddress()
Returns the bind address on the host.- Returns:
- the bind address on the host
-
getMaximumTimeBetweenPings
int getMaximumTimeBetweenPings()
Returns the maximum amount of time between client pings.- Returns:
- the maximum amount of time between client pings
-
isRunning
boolean isRunning()
Returns whether the receiver is in running state.- Returns:
- True if the receiver is in a running state, false otherwise.
-
getEventsReceivedRate
float getEventsReceivedRate()
Returns the instantaneous rate of events received.- Returns:
- the instantaneous rate of events received
-
getCreateRequestsRate
float getCreateRequestsRate()
Returns the rate of create requests received.- Returns:
- the rate of create requests received
-
getUpdateRequestsRate
float getUpdateRequestsRate()
Returns the rate of update requests received.- Returns:
- the rate of update requests received
-
getDestroyRequestsRate
float getDestroyRequestsRate()
Returns the rate of destroy requests received.- Returns:
- the rate of destroy requests received
-
getDuplicateBatchesReceived
int getDuplicateBatchesReceived()
Returns the number of duplicate batches which have been received.- Returns:
- the number of duplicate batches which have been received
-
getOutoforderBatchesReceived
int getOutoforderBatchesReceived()
Returns the number of batches which have been received out of order.- Returns:
- the number of batches which have been received out of order
-
start
void start() throws java.lang.ExceptionStarts the gateway receiver.- Throws:
java.lang.Exception- if an exception is encountered when starting the receiver
-
stop
void stop() throws java.lang.Exception
Stops the gateway receiver.- Throws:
java.lang.Exception- if an exception is encountered when stopping the receiver
-
getStartPort
int getStartPort()
Returns the configured start port.- Returns:
- the configured start port
-
getEndPort
int getEndPort()
Returns the configured end port.- Returns:
- the configured end port
-
getGatewayTransportFilters
java.lang.String[] getGatewayTransportFilters()
Returns a list of names for the transport filters in use.- Returns:
- a list of names for the transport filters in use
-
getClientConnectionCount
int getClientConnectionCount()
Returns the number of sockets accepted and used for client to server messaging.- Returns:
- the number of sockets accepted and used for client to server messaging
-
getNumGateways
int getNumGateways()
Returns the number of client virtual machines connected and acting as a gateway.- Returns:
- the number of client virtual machines connected and acting as a gateway
-
getGetRequestAvgLatency
long getGetRequestAvgLatency()
Returns the average get request latency.- Returns:
- the average get request latency
-
getPutRequestAvgLatency
long getPutRequestAvgLatency()
Returns the average put request latency.- Returns:
- the average put request latency
-
getTotalConnectionsTimedOut
int getTotalConnectionsTimedOut()
Returns the total number of client connections that timed out and were closed.- Returns:
- the total number of client connections that timed out and were closed
-
getTotalFailedConnectionAttempts
int getTotalFailedConnectionAttempts()
Returns the total number of client connection requests that failed.- Returns:
- the total number of client connection requests that failed
-
getThreadQueueSize
int getThreadQueueSize()
Returns the current number of connections waiting for a thread to start processing their message.- Returns:
- the current number of connections waiting for a thread to start processing their message
-
getConnectionThreads
int getConnectionThreads()
Returns the current number of threads handling a client connection.- Returns:
- the current number of threads handling a client connection
-
getConnectionLoad
double getConnectionLoad()
Returns the load from client to server connections as reported by the load probe installed in this server.- Returns:
- the load from client to server connections as reported by the load probe installed in this server
-
getLoadPerConnection
double getLoadPerConnection()
Returns the estimate of how much load is added for each new connection as reported by the load probe installed in this server.- Returns:
- the estimate of how much load is added for each new connection as reported by the load probe installed in this server
-
getQueueLoad
double getQueueLoad()
Returns the load from queues as reported by the load probe installed in this server.- Returns:
- the load from queues as reported by the load probe installed in this server
-
getLoadPerQueue
double getLoadPerQueue()
Returns the estimate of how much load is added for each new queue as reported by the load probe installed in this server.- Returns:
- the estimate of how much load is added for each new queue as reported by the load probe installed in this server
-
getGetRequestRate
float getGetRequestRate()
Returns the rate of get requests.- Returns:
- the rate of get requests
-
getPutRequestRate
float getPutRequestRate()
Returns the rate of put requests.- Returns:
- the rate of put requests
-
getTotalSentBytes
long getTotalSentBytes()
Returns the total number of bytes sent to clients.- Returns:
- the total number of bytes sent to clients
-
getTotalReceivedBytes
long getTotalReceivedBytes()
Returns the total number of bytes received from clients.- Returns:
- the total number of bytes received from clients
-
getConnectedGatewaySenders
java.lang.String[] getConnectedGatewaySenders()
Returns a list of the host and port information for gateway senders connected to this gateway receiver.- Returns:
- an array of the host and port information for gateway senders connected to this gateway receiver
-
getAverageBatchProcessingTime
long getAverageBatchProcessingTime()
Returns the average batch processing time (in milliseconds).- Returns:
- the average batch processing time (in milliseconds)
-
getHostnameForSenders
default java.lang.String getHostnameForSenders()
Returns the hostname for receiver for the remote senders to connect to.- Returns:
- the hostname of the receiver for the sender
-
-