Module bus.core
Package org.miaixz.bus.core.io.sink

Interface Sink

All Superinterfaces:
AutoCloseable, Closeable, Flushable
All Known Subinterfaces:
BufferSink
All Known Implementing Classes:
AssignSink, Buffer, DeflaterSink, FaultHideSink, GzipSink, RealSink
public interface Sink extends Closeable, Flushable
字节流接收器接口，用于将数据写入目标（如网络、存储或内存缓冲区）。 支持分层处理以转换数据（如压缩、加密、节流或协议框架）。 通过 BufferSink.outputStream() 可适配为 OutputStream。
Since:
Java 17+
Author:
Kimi Liu

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    推送缓冲数据到最终目标并释放资源。
    void
    flush()
    将缓冲区中的所有数据推送到最终目标。
    Timeout
    timeout()
    获取接收器的超时配置。
    void
    write(Buffer source, long byteCount)
    从源读取指定字节数并写入当前接收器。

  • Method Details

    • write

      void write(Buffer source, long byteCount) throws IOException
      从源读取指定字节数并写入当前接收器。
      Parameters:
      source - 数据源缓冲区
      byteCount - 要读取的字节数
      Throws:
      IOException - 如果读取或写入失败

    • flush

      void flush() throws IOException
      将缓冲区中的所有数据推送到最终目标。
      Specified by:
      flush in interface Flushable
      Throws:
      IOException - 如果刷新失败

    • timeout

      Timeout timeout()
      获取接收器的超时配置。
      Returns:
      超时对象

    • close

      void close() throws IOException
      推送缓冲数据到最终目标并释放资源。关闭后不可再次写入，可安全多次关闭。
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException - 如果关闭失败