CacheServer
instead.@Deprecated public interface BridgeServer
Cache
to VMs in another distributed system via a
socket. A bridge server is used in conjunction with a
client Pool
to connect two regions
that reside in different distributed systems.Cache.addBridgeServer()
,
Cache.getBridgeServers()
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_BIND_ADDRESS
Deprecated.
The default ip address or host name that the server's socket will
listen on for client connections.
|
static String[] |
DEFAULT_GROUPS
Deprecated.
The default list of server groups a server belongs to.
|
static String |
DEFAULT_HOSTNAME_FOR_CLIENTS
Deprecated.
The default ip address or host name that will be given to clients
as the host this server is listening on.
|
static long |
DEFAULT_LOAD_POLL_INTERVAL
Deprecated.
The default frequency at which to poll the load probe for the load
on this server.
|
static ServerLoadProbe |
DEFAULT_LOAD_PROBE
Deprecated.
The default load balancing probe.
|
static int |
DEFAULT_MAX_CONNECTIONS
Deprecated.
The default number of sockets accepted by a BridgeServer.
|
static int |
DEFAULT_MAX_THREADS
Deprecated.
The default limit to the maximum number of server threads that can be
created to service client requests.
|
static int |
DEFAULT_MAXIMUM_MESSAGE_COUNT
Deprecated.
The default maximum number of messages that can be enqueued in a
client-queue.
|
static int |
DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS
Deprecated.
The default maximum amount of time between client pings.
|
static int |
DEFAULT_MESSAGE_TIME_TO_LIVE
Deprecated.
The default time (in seconds ) after which a message in the client queue
will expire.
|
static boolean |
DEFAULT_NOTIFY_BY_SUBSCRIPTION
Deprecated.
The default notify-by-subscription value which tells the
BridgeServer whether or not to notify clients
based on key subscription. |
static int |
DEFAULT_PORT
Deprecated.
The default port on which a
BridgeServer is
configured to serve. |
static int |
DEFAULT_SOCKET_BUFFER_SIZE
Deprecated.
The default socket buffer size for socket buffers from the server
to the client.
|
Modifier and Type | Method and Description |
---|---|
Set |
getAllClientSessions()
Deprecated.
Returns a set of all
ClientSession s |
String |
getBindAddress()
Deprecated.
Returns a string representing the ip address or host name that this server
will listen on.
|
ClientSession |
getClientSession(DistributedMember member)
Deprecated.
Returns the
ClientSession associated with the
DistributedMember |
ClientSession |
getClientSession(String durableClientId)
Deprecated.
Returns the
ClientSession associated with the
durable client id |
ClientSubscriptionConfig |
getClientSubscriptionConfig()
Deprecated.
Get the ClientSubscriptionConfig for this cache server.
|
String[] |
getGroups()
Deprecated.
Returns the list of server groups that this cache server belongs to.
|
String |
getHostnameForClients()
Deprecated.
Returns a string representing the ip address or host name that server locators
will tell clients that this server is listening on.
|
long |
getLoadPollInterval()
Deprecated.
Get the frequency in milliseconds to poll the load probe on this cache
server.
|
ServerLoadProbe |
getLoadProbe()
Deprecated.
Get the load probe for this cache server.
|
int |
getMaxConnections()
Deprecated.
Returns the maximum allowed client connections
|
int |
getMaximumMessageCount()
Deprecated.
Returns the maximum number of messages that can be enqueued in a
client-queue.
|
int |
getMaximumTimeBetweenPings()
Deprecated.
Returns the maximum amount of time between client pings.
|
int |
getMaxThreads()
Deprecated.
Returns the maxium number of threads allowed in this server to service
client requests.
|
int |
getMessageTimeToLive()
Deprecated.
Returns the time (in seconds ) after which a message in the client queue
will expire.
|
boolean |
getNotifyBySubscription()
Deprecated.
as of 6.0.1. This method is no more in use, by default
notifyBySubscription attribute is set to true.
|
int |
getPort()
Deprecated.
Returns the port on which this server listens for clients.
|
int |
getSocketBufferSize()
Deprecated.
Returns the configured buffer size of the socket connection for this
BridgeServer . |
boolean |
isRunning()
Deprecated.
Returns whether or not this server is running
|
void |
setBindAddress(String address)
Deprecated.
Sets the ip address or host name that this server is to listen on for
client connections.
|
void |
setGroups(String[] groups)
Deprecated.
Sets the list of server groups this cache server will belong to.
|
void |
setHostnameForClients(String name)
Deprecated.
Sets the ip address or host name that this server is to listen on for
client connections.
|
void |
setLoadPollInterval(long loadPollInterval)
Deprecated.
Set the frequency in milliseconds to poll the load probe on this cache
server
|
void |
setLoadProbe(ServerLoadProbe loadProbe)
Deprecated.
Set the load probe for this cache server.
|
void |
setMaxConnections(int maxCons)
Deprecated.
Sets the maxium number of client connections allowed.
|
void |
setMaximumMessageCount(int maxMessageCount)
Deprecated.
Sets maximum number of messages that can be enqueued in a client-queue.
|
void |
setMaximumTimeBetweenPings(int maximumTimeBetweenPings)
Deprecated.
Sets the maximum amount of time between client pings.
|
void |
setMaxThreads(int maxThreads)
Deprecated.
Sets the maxium number of threads allowed in this server to service
client requests.
|
void |
setMessageTimeToLive(int messageTimeToLive)
Deprecated.
Sets the time (in seconds ) after which a message in the client queue
will expire.Expiry settings are applicable for the secondary queues only
This setting has no impact on the primary queue.
|
void |
setNotifyBySubscription(boolean b)
Deprecated.
as of 6.0.1. This method is no more in use, by default
notifyBySubscription attribute is set to true.
|
void |
setPort(int port)
Deprecated.
Sets the port on which this server listens for clients.
|
void |
setSocketBufferSize(int socketBufferSize)
Deprecated.
Sets the buffer size in bytes of the socket connection for this
BridgeServer . |
void |
start()
Deprecated.
Starts this server.
|
void |
stop()
Deprecated.
Stops this server.
|
static final int DEFAULT_PORT
BridgeServer
is
configured to serve.static final int DEFAULT_MAX_CONNECTIONS
static final int DEFAULT_MAX_THREADS
0
causes a thread to be bound to every connection
and to be dedicated to detecting client requests on that connection. A selector
is not used in this default mode.
Current value: 0static final boolean DEFAULT_NOTIFY_BY_SUBSCRIPTION
BridgeServer
whether or not to notify clients
based on key subscription.static final int DEFAULT_SOCKET_BUFFER_SIZE
static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS
ClientHealthMonitor
to determine the
health of this BridgeServer
's clients.static final int DEFAULT_MAXIMUM_MESSAGE_COUNT
static final int DEFAULT_MESSAGE_TIME_TO_LIVE
static final String[] DEFAULT_GROUPS
static final ServerLoadProbe DEFAULT_LOAD_PROBE
static final long DEFAULT_LOAD_POLL_INTERVAL
static final String DEFAULT_BIND_ADDRESS
static final String DEFAULT_HOSTNAME_FOR_CLIENTS
int getPort()
void setPort(int port)
IllegalStateException
- If this server is runningString getBindAddress()
DEFAULT_BIND_ADDRESS
void setBindAddress(String address)
Setting a specific bind address will cause the server to always
use this address and ignore any address specified by "server-bind-address"
or "bind-address" in the gemfire.properties
file
(see DistributedSystem
for a description of these properties).
The value ""
does not override the gemfire.properties
.
It will cause the local machine's default address to be listened on if the
properties file does not specify and address.
If you wish to override the properties and want to have your server bind to all local
addresses then use this bind address "0.0.0.0"
.
A null
value will be treated the same as the default ""
.
address
- the ip address or host name that this server is to listen onDEFAULT_BIND_ADDRESS
String getHostnameForClients()
DEFAULT_HOSTNAME_FOR_CLIENTS
void setHostnameForClients(String name)
Setting a specific hostname-for-clients will cause server locators to use this value when telling clients how to connect to this server. This is useful in the case where the server may refer to itself with one hostname, but the clients need to use a different hostname to find the server.
The value ""
causes the bind-address
to be given to clients.
A null
value will be treated the same as the default ""
.
name
- the ip address or host name that will be given to clients
so they can connect to this serverDEFAULT_HOSTNAME_FOR_CLIENTS
@Deprecated void setNotifyBySubscription(boolean b)
@Deprecated boolean getNotifyBySubscription()
void setSocketBufferSize(int socketBufferSize)
BridgeServer
. The default is 32768 bytes.socketBufferSize
- The size in bytes of the socket bufferint getSocketBufferSize()
BridgeServer
. The default is 32768 bytes.BridgeServer
void setMaximumTimeBetweenPings(int maximumTimeBetweenPings)
ClientHealthMonitor
to determine the health
of this BridgeServer
's clients. The default is 60000 ms.maximumTimeBetweenPings
- The maximum amount of time between client
pingsint getMaximumTimeBetweenPings()
ClientHealthMonitor
to determine the health
of this BridgeServer
's clients. The default is 60000 ms.void start() throws IOException
IOException
- If an error occurs while starting the serverboolean isRunning()
void stop()
BridgeServer
can be reconfigured and restarted if
desired.int getMaxConnections()
void setMaxConnections(int maxCons)
DEFAULT_MAX_CONNECTIONS
int getMaxThreads()
0
causes the server to dedicate a thread for
every client connection.void setMaxThreads(int maxThreads)
0
causes the server to dedicate a thread for
every client connection.DEFAULT_MAX_THREADS
int getMaximumMessageCount()
void setMaximumMessageCount(int maxMessageCount)
DEFAULT_MAXIMUM_MESSAGE_COUNT
int getMessageTimeToLive()
void setMessageTimeToLive(int messageTimeToLive)
DEFAULT_MESSAGE_TIME_TO_LIVE
ClientSession getClientSession(DistributedMember member)
ClientSession
associated with the
DistributedMember
ClientSession
associated with the
DistributedMember
ClientSession getClientSession(String durableClientId)
ClientSession
associated with the
durable client idClientSession
associated with the
durableSet getAllClientSessions()
ClientSession
sClientSession
svoid setGroups(String[] groups)
groups
- possibly empty array of String
where each string
is a server groups that this cache server will be a member of.DEFAULT_GROUPS
String[] getGroups()
String
s where
each string is a server group. Modifying this array will not change the
server groups that this cache server belongs to.ServerLoadProbe getLoadProbe()
ServerLoadProbe
for details on the load probe.void setLoadProbe(ServerLoadProbe loadProbe)
ServerLoadProbe
for details on how to implement
a load probe.loadProbe
- the load probe to use for
this cache server.long getLoadPollInterval()
void setLoadPollInterval(long loadPollInterval)
loadPollInterval
- the frequency in milliseconds to poll
the load probe. Must be greater than 0.ClientSubscriptionConfig getClientSubscriptionConfig()
ClientSubscriptionConfig
for details on the client subscription configuration.Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.