Skip navigation links
org.apache.geode.cache.wan

Interface GatewayReceiver

    • Field Summary

      Fields 
      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 java.lang.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 java.lang.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
      static java.lang.String RECEIVER_GROUP 

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.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.
      java.util.List<GatewayTransportFilter> getGatewayTransportFilters()
      Returns the list of GatewayTransportFilter added to this GatewayReceiver.
      java.lang.String getHost()
      Returns a string representing the ip address or host name that server locators will tell clients (GatewaySenders 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.
      CacheServer getServer()
      Return the underlying Cacheserver
      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.

    • Field Detail

      • DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS

        static final int DEFAULT_MAXIMUM_TIME_BETWEEN_PINGS
        The default maximum amount of time between client pings. This value is used by the ClientHealthMonitor to determine the health of this GatewayReceiver's clients.
        See Also:
        Constant Field Values

      • DEFAULT_START_PORT

        static final int DEFAULT_START_PORT
        Default start value of the port range from which the GatewayReceiver's port will be chosen
        See Also:
        Constant Field Values

      • DEFAULT_END_PORT

        static final int DEFAULT_END_PORT
        Default end value of the port range from which the GatewayReceiver's port will be chosen
        See Also:
        Constant Field Values

      • DEFAULT_SOCKET_BUFFER_SIZE

        static final int DEFAULT_SOCKET_BUFFER_SIZE
        The default buffer size for socket buffers for the GatewayReceiver.
        See Also:
        Constant Field Values

      • DEFAULT_BIND_ADDRESS

        static final java.lang.String DEFAULT_BIND_ADDRESS
        The default ip address or host name that the receiver's socket will listen on for client connections. The current default is an empty string.
        See Also:
        Constant Field Values

      • DEFAULT_HOSTNAME_FOR_SENDERS

        static final java.lang.String DEFAULT_HOSTNAME_FOR_SENDERS
        See Also:
        Constant Field Values

      • DEFAULT_MANUAL_START

        static final boolean DEFAULT_MANUAL_START
        The default value (true) for manually starting a GatewayReceiver.
        Since:
        GemFire 8.1
        See Also:
        Constant Field Values

      • APPLY_RETRIES

        static final 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.

    • Method Detail

      • start

        void start()
    throws java.io.IOException
        Starts this receiver. Once the receiver is running, its configuration cannot be changed.
        Throws:
        java.io.IOException - If an error occurs while starting the receiver

      • stop

        void stop()
        Stops this receiver. Note that the GatewayReceiver can be reconfigured and restarted if desired.

      • isRunning

        boolean isRunning()
        Returns whether or not this receiver is running

      • getGatewayTransportFilters

        java.util.List<GatewayTransportFilter> getGatewayTransportFilters()
        Returns the list of GatewayTransportFilter added to this GatewayReceiver.
        Returns:
        the list of GatewayTransportFilter added to this GatewayReceiver.

      • getMaximumTimeBetweenPings

        int getMaximumTimeBetweenPings()
        Returns the maximum amount of time between client pings. This value is used by the ClientHealthMonitor to determine the health of this GatewayReceiver's clients (i.e. the GatewaySenders). The default is 60000 ms.
        Returns:
        the maximum amount of time between client pings.

      • getPort

        int getPort()
        Returns the port on which this GatewayReceiver listens for clients.

      • getStartPort

        int getStartPort()
        Returns start value of the port range from which the GatewayReceiver's port will be chosen.

      • getEndPort

        int getEndPort()
        Returns end value of the port range from which the GatewayReceiver's port will be chosen.

      • getHost

        java.lang.String getHost()
        Returns a string representing the ip address or host name that server locators will tell clients (GatewaySenders in this case) that this receiver is listening on.
        Returns:
        the ip address or host name to give to clients so they can connect to this receiver

      • getSocketBufferSize

        int getSocketBufferSize()
        Returns the configured buffer size of the socket connection for this GatewayReceiver. The default is 524288 bytes.
        Returns:
        the configured buffer size of the socket connection for this GatewayReceiver

      • getBindAddress

        java.lang.String getBindAddress()
        Returns a string representing the ip address or host name that this server will listen on.
        Returns:
        the ip address or host name that this server is to listen on
        See Also:
        DEFAULT_BIND_ADDRESS

      • isManualStart

        boolean isManualStart()
        Returns the manual start boolean property for this GatewayReceiver. Default is true i.e. the GatewayReceiver will not automatically start once created.
        Returns:
        the manual start boolean property for this GatewayReceiver

      • getServer

        CacheServer getServer()
        Return the underlying Cacheserver
Skip navigation links