tigase.server.xmppclient

## Interface XMPPIOProcessor

- All Known Implementing Classes:
    RegistrationThrottlingProcessor, StreamErrorCounterIOProcessor, StreamManagementIOProcessor

      public interface XMPPIOProcessor

  Author:
    andrzej

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getId()` Returns identifier of processor
    `void` | `getStatistics(StatisticsList list)` Returns statistics generated by this processor
    `void` | `packetsSent(XMPPIOService service)` Method is called when all waiting data was written to socket.
    `void` | `processCommand(XMPPIOService service, Packet packet)` Process command execution which may be sent from other component and should be processed by processor
    `boolean` | `processIncoming(XMPPIOService service, Packet packet)` Process packets read from socket as they are sent to SessionManager.
    `boolean` | `processOutgoing(XMPPIOService service, Packet packet)` Process outgoing packets as they are added to XMPPIOService outgoing packets queue.
    `boolean` | `serviceStopped(XMPPIOService service, boolean streamClosed)` Method called when XMPPIOService is closed.
    `void` | `setConnectionManager(ConnectionManager connectionManager)` Sets connection manager instance for which this XMPPIOProcessor is used
    `void` | `setProperties(Map<String,Object> props)` Method used for setting properties
    `void` | `streamError(XMPPIOService service, StreamError streamError)` Method called when XMPP stream error is about to be sent
    `Element[]` | `supStreamFeatures(XMPPIOService service)` Returns array of features added by this processor

- - ### Method Detail

    - #### getId

          String getId()

      Returns identifier of processor

    - #### getStatistics

          void getStatistics(StatisticsList list)

      Returns statistics generated by this processor
      Parameters:
        `list` -

    - #### supStreamFeatures

          Element[] supStreamFeatures(XMPPIOService service)

      Returns array of features added by this processor
      Parameters:
        `service` -

    - #### processIncoming

          boolean processIncoming(XMPPIOService service,
                                  Packet packet)

      Process packets read from socket as they are sent to SessionManager.
      Parameters:
        `service` -
        `packet` -
      Returns:
        true if packet should not be forwarded

    - #### processOutgoing

          boolean processOutgoing(XMPPIOService service,
                                  Packet packet)

      Process outgoing packets as they are added to XMPPIOService outgoing packets queue.
      Parameters:
        `service` -
        `packet` -
      Returns:
        true if packet should be removed

    - #### packetsSent

          void packetsSent(XMPPIOService service)
                    throws IOException

      Method is called when all waiting data was written to socket.
      Parameters:
        `service` -
      Throws:
        `IOException`

    - #### processCommand

          void processCommand(XMPPIOService service,
                              Packet packet)

      Process command execution which may be sent from other component and should be processed by processor
      Parameters:
        `packet` -

    - #### serviceStopped

          boolean serviceStopped(XMPPIOService service,
                                 boolean streamClosed)

      Method called when XMPPIOService is closed.
      Parameters:
        `service` -
        `streamClosed` -
      Returns:
        true if connecton manager should not be notified about stopping of this service

    - #### setConnectionManager

          void setConnectionManager(ConnectionManager connectionManager)

      Sets connection manager instance for which this XMPPIOProcessor is used
      Parameters:
        `connectionManager` -

    - #### setProperties

          void setProperties(Map<String,Object> props)

      Method used for setting properties
      Parameters:
        `props` -

    - #### streamError

          void streamError(XMPPIOService service,
                           StreamError streamError)

      Method called when XMPP stream error is about to be sent
      Parameters:
        `service` -
        `streamErrorName` -

Copyright © 2017 "Tigase, Inc.". All rights reserved.