Package org.firebirdsql.gds.ng.wire

Interface FbWireOperations

All Known Implementing Classes:
AbstractWireOperations, V10WireOperations, V11WireOperations, V13WireOperations, V15WireOperations
public interface FbWireOperations
Common connection operations shared by database and service handles
Since:
3.0
Author:
Mark Rotteveel

  • Method Details

    • getXdrStreamAccess

      XdrStreamAccess getXdrStreamAccess()
      Returns:
      Instance of XdrStreamAccess for this service.

    • readStatusVector

      SQLException readStatusVector() throws SQLException
      Process the status vector and returns the associated SQLException instance.

      NOTE: This method returns the SQLException read from the status vector, and only throws SQLException when an error occurs processing the status ector.

      Returns:
      SQLException from the status vector
      Throws:
      SQLException - for errors reading or processing the status vector

    • readResponse

      Response readResponse(WarningMessageCallback callback) throws SQLException, IOException
      Reads the response from the server.
      Parameters:
      callback - Callback object for warnings, null for default callback
      Returns:
      Response read.
      Throws:
      SQLException - For errors returned from the server, or when attempting to read
      IOException - For errors reading the response from the connection.

    • readOperationResponse

      Response readOperationResponse(int operationCode, WarningMessageCallback callback) throws SQLException, IOException
      Reads the response from the server when the operation code has already been read.
      Parameters:
      operationCode - The operation code
      callback - Callback object for warnings, null for default callback
      Returns:
      Response read.
      Throws:
      SQLException - For errors returned from the server, or when attempting to read
      IOException - For errors reading the response from the connection.
      See Also:

    • readGenericResponse

      GenericResponse readGenericResponse(WarningMessageCallback callback) throws SQLException, IOException
      Convenience method to read a Response to a GenericResponse
      Parameters:
      callback - Callback object for warnings, null for default callback
      Returns:
      GenericResponse
      Throws:
      SQLException - For errors returned from the server, or when attempting to read.
      IOException - For errors reading the response from the connection.

    • readSqlResponse

      SqlResponse readSqlResponse(WarningMessageCallback callback) throws SQLException, IOException
      Convenience method to read a Response to a SqlResponse
      Parameters:
      callback - Callback object for warnings, null for default callback
      Returns:
      SqlResponse
      Throws:
      SQLException - For errors returned from the server, or when attempting to read.
      IOException - For errors reading the response from the connection.

    • handleCryptKeyCallback

      void handleCryptKeyCallback(DbCryptCallback dbCryptCallback) throws IOException, SQLException
      Handles the database encryption key callback.
      Parameters:
      dbCryptCallback - Database encryption callback plugin
      Throws:
      IOException - For errors reading data from the socket
      SQLException - For database errors
      SQLFeatureNotSupportedException - If this protocol version does not support crypt key callbacks
      Since:
      4.0

    • enqueueDeferredAction

      void enqueueDeferredAction(DeferredAction deferredAction)
      Enqueue a deferred action.

      FbDatabase implementations that do not support deferred actions are allowed to throw an UnsupportedOperationException

      Parameters:
      deferredAction - Deferred action

    • consumePackets

      void consumePackets(int numberOfResponses, WarningMessageCallback warningCallback)
      Consumes packets notifying for warnings, but ignoring exceptions thrown from the packet.

      This method should only be used inside the implementation if either packets need to be ignored, or to ensure that there is no backlog of packets (eg when an exception occurs during processing of multiple package responses).

      Parameters:
      numberOfResponses - Number of responses to consume.
      warningCallback - Callback for warnings

    • processDeferredActions

      void processDeferredActions()
      Processes any deferred actions. Protocol versions that do not support deferred actions should simply do nothing.

    • readSingleResponse

      Response readSingleResponse(WarningMessageCallback warningCallback) throws SQLException, IOException
      Reads the response from the server.
      Parameters:
      warningCallback - Callback object for signalling warnings, null to register warning on the default callback
      Returns:
      Response
      Throws:
      SQLException - For errors returned from the server, or when attempting to read
      IOException - For errors reading the response from the connection.

    • processResponse

      void processResponse(Response response) throws SQLException
      Parameters:
      response - Response to process
      Throws:
      SQLException - For errors returned from the server.

    • processResponseWarnings

      void processResponseWarnings(Response response, WarningMessageCallback warningCallback)
      Checks if the response included a warning and signals that warning to the WarningMessageCallback.
      Parameters:
      response - Response to process

    • writeDirect

      void writeDirect(byte[] data) throws IOException
      Writes directly to the OutputStream of the underlying connection.

      Use of this method might lead to hard to find race conditions in the protocol. It is currently only used to allow FbDatabase.cancelOperation(int) to work.

      Parameters:
      data - Data to write
      Throws:
      IOException - If there is no socket, the socket is closed, or for errors writing to the socket.
      See Also:

    • authReceiveResponse

      void authReceiveResponse(FbWireAttachment.AcceptPacket acceptPacket, DbCryptCallback dbCryptCallback, FbWireOperations.ProcessAttachCallback processAttachCallback) throws IOException, SQLException
      Receive authentication response from the server.

      This method is only relevant for protocol V13 or higher.

      Parameters:
      acceptPacket - Packet with op_cond_accept data, or null when the data should be read from the connection.
      dbCryptCallback - Database encryption callback (ignored by protocols v12 and lower)
      processAttachCallback - Callback for processing the final attach response
      Throws:
      IOException - For errors reading the response from the connection.
      SQLException - For errors returned from the server, or when attempting to read.

    • setNetworkTimeout

      void setNetworkTimeout(int milliseconds) throws SQLException
      Sets the network timeout for this attachment.
      Parameters:
      milliseconds - Timeout in milliseconds; 0 means no timeout. If the attachment doesn't support milliseconds, it should round up to the nearest second.
      Throws:
      SQLException - If this attachment is closed, the value of milliseconds is smaller than 0, or if setting the timeout fails.
      SQLFeatureNotSupportedException - If this attachment doesn't support changing the network timeout.