public interface GatewayReceiver
GatewaySender
.
GatewayReceiver is used in conjunction with a GatewaySender
to
connect two distributed-systems. This GatewayReceiver will receive all the
events originating in distributed-systems that has a
GatewaySender connected to this distributed-system.
Modifier and Type | Field and Description |
---|---|
static boolean |
APPLY_RETRIES
If the batch already seen by this receiver, arrives again then whether it is to be
re-applied or not is decided by this attribute.
|
static String |
DEFAULT_BIND_ADDRESS
The default ip address or host name that the receiver's socket will
listen on for client connections.
|
static int |
DEFAULT_END_PORT
Default end value of the port range from which the
GatewayReceiver 's port will be chosen |
static String |
DEFAULT_HOSTNAME_FOR_SENDERS |
static boolean |
DEFAULT_MANUAL_START
The default value (true) for manually starting a
GatewayReceiver . |
static int |
DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS
The default maximum amount of time between client pings.
|
static int |
DEFAULT_SOCKET_BUFFER_SIZE
The default buffer size for socket buffers for the
GatewayReceiver . |
static int |
DEFAULT_START_PORT
Default start value of the port range from which the
GatewayReceiver 's port will be chosen |
Modifier and Type | Method and Description |
---|---|
String |
getBindAddress()
Returns a string representing the ip address or host name that this server
will listen on.
|
int |
getEndPort()
Returns end value of the port range from which the
GatewayReceiver 's port will be chosen. |
List<GatewayTransportFilter> |
getGatewayTransportFilters()
Returns the list of
GatewayTransportFilter added to this
GatewayReceiver. |
String |
getHost()
Returns a string representing the ip address or host name that server locators
will tell clients (
GatewaySender s in this case) that this receiver is listening on. |
int |
getMaximumTimeBetweenPings()
Returns the maximum amount of time between client pings.
|
int |
getPort()
Returns the port on which this
GatewayReceiver listens for clients. |
int |
getSocketBufferSize()
Returns the configured buffer size of the socket connection for this
GatewayReceiver . |
int |
getStartPort()
Returns start value of the port range from which the
GatewayReceiver 's port will be chosen. |
boolean |
isManualStart()
Returns the manual start boolean property for this GatewayReceiver.
|
boolean |
isRunning()
Returns whether or not this receiver is running
|
void |
start()
Starts this receiver.
|
void |
stop()
Stops this receiver.
|
static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS
ClientHealthMonitor
to determine the
health of this GatewayReceiver
's clients.static final int DEFAULT_START_PORT
GatewayReceiver
's port will be chosenstatic final int DEFAULT_END_PORT
GatewayReceiver
's port will be chosenstatic final int DEFAULT_SOCKET_BUFFER_SIZE
GatewayReceiver
.static final String DEFAULT_BIND_ADDRESS
static final String DEFAULT_HOSTNAME_FOR_SENDERS
static final boolean DEFAULT_MANUAL_START
GatewayReceiver
.static final boolean APPLY_RETRIES
void start() throws IOException
IOException
- If an error occurs while starting the receivervoid stop()
GatewayReceiver
can be reconfigured and restarted if
desired.boolean isRunning()
List<GatewayTransportFilter> getGatewayTransportFilters()
GatewayTransportFilter
added to this
GatewayReceiver.GatewayTransportFilter
added to this
GatewayReceiver.int getMaximumTimeBetweenPings()
ClientHealthMonitor
to determine the health
of this GatewayReceiver
's clients (i.e. the GatewaySenders).
The default is 60000 ms.int getPort()
GatewayReceiver
listens for clients.int getStartPort()
GatewayReceiver
's port will be chosen.int getEndPort()
GatewayReceiver
's port will be chosen.String getHost()
GatewaySender
s in this case) that this receiver is listening on.int getSocketBufferSize()
GatewayReceiver
. The default is 524288 bytes.GatewayReceiver
String getBindAddress()
DEFAULT_BIND_ADDRESS
boolean isManualStart()
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.