Package org.apache.cayenne.rop

# Interface ROPConnector

All Known Implementing Classes:
  `HttpROPConnector`

public interface ROPConnector
ROP network connectivity interface.

Since:
  4.0

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `close()`
  Close all resources related to ROP Connector.
  `InputStream`
  `establishSession()`
  Establishes a dedicated session with Cayenne DataChannel, returning session id.
  `InputStream`
  `establishSharedSession(String sharedSessionName)`
  Creates a new session with the specified or joins an existing one.
  `InputStream`
  `sendMessage(byte[] message)`
  Processes message on a remote server, returning the result of such processing.

- ## Method Details

  - ### establishSession

    InputStream establishSession() throws IOException
    Establishes a dedicated session with Cayenne DataChannel, returning session id.
    Throws:
      `IOException`

  - ### establishSharedSession

    InputStream establishSharedSession(String sharedSessionName) throws IOException
    Creates a new session with the specified or joins an existing one. This method is used to bootstrap collaborating clients of a single "group chat".
    Throws:
      `IOException`

  - ### sendMessage

    InputStream sendMessage(byte[] message) throws IOException
    Processes message on a remote server, returning the result of such processing.
    Throws:
      `IOException`

  - ### close

    void close() throws IOException
    Close all resources related to ROP Connector.
    Throws:
      `IOException`