Interface LogCallback

  • All Known Implementing Classes:
    DefaultLogCallback

    public interface LogCallback
    Interface called for each log line received from the docker host when asynchronous log fetching is used.
    Since:
    21/11/14
    Author:
    roland
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  LogCallback.DoneException
      Exception indicating that logging is done and should be finished
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Invoked by a user when callback is no longer used.
      void error​(String error)
      Method called in case on an error when reading the logs
      void log​(int type, ZonedDateTime timestamp, String txt)
      Receive a log entry
      void open()
      To be called by a client to start the callback and allocate the underlying output stream.
    • Method Detail

      • error

        void error​(String error)
        Method called in case on an error when reading the logs
        Parameters:
        error - error description
      • open

        void open()
           throws IOException
        To be called by a client to start the callback and allocate the underlying output stream. In case of a shared stream it might be that the stream is reused
        Throws:
        IOException
      • close

        void close()
        Invoked by a user when callback is no longer used. Closing the underlying stream may be delayed by the implementation when this stream is shared between multiple clients.