AbstractPacketOutputStream (oceanbase-client 2.4.11 API)

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
  - - com.oceanbase.jdbc.internal.io.output.AbstractPacketOutputStream

所有已实现的接口:

PacketOutputStream, Closeable, Flushable, AutoCloseable

直接已知子类:

CompressPacketOutputStream, Ob20PacketOutputStream, StandardPacketOutputStream
```
public abstract class AbstractPacketOutputStream
extends FilterOutputStream
implements PacketOutputStream
```

字段概要

字段
限定符和类型	字段和说明
`protected byte[]`	`buf`
`protected Charset`	`charset`
`protected long`	`cmdLength`
`protected boolean`	`enableNetworkStatistics`
`protected int`	`maxAllowedPacket`
`protected int`	`maxPacketLength`
`protected int`	`maxQuerySizeToLog`
`protected int`	`mysqlSeqNo`
`protected boolean`	`permitTrace`
`protected int`	`pos` relative position in mysql payload
`protected String`	`serverThreadLog`
`protected long`	`threadId`
`protected long`	`timestampBeforeFlush`
`protected LruTraceCache`	`traceCache`

从类继承的字段 java.io.FilterOutputStream
out

构造器概要

构造器
构造器和说明
`AbstractPacketOutputStream(OutputStream out, int maxQuerySizeToLog, long threadId, String encoding, TimeTrace timeTrace, boolean encloseParamInParentheses)` Common feature to write data into socket, creating MariaDB Packet.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`boolean`	`bufferIsDataAfterMark()`
`void`	`checkMaxAllowedLength(int length)` Count query size.
`boolean`	`checkRemainingSize(int len)`
`void`	`clearNetworkStatistics()`
`void`	`doFlush()`
`void`	`enableNetworkStatistics(boolean flag)`
`void`	`endSendRequest()`
`boolean`	`exceedMaxLength()`
`void`	`flush()` Send packet to socket.
`protected abstract void`	`flushBuffer(boolean commandEnd)`
`void`	`flushBufferStopAtMark()` Flush to last mark.
`void`	`flushLoadDataLocalFile()`
`Charset`	`getCharset()`
`int`	`getMaxAllowedPacket()`
`int`	`getMaxPacketLength()`
`OutputStream`	`getOutputStream()`
`int`	`getPosition()` Get current position
`long`	`getTimestampBeforeFlush()`
`TimeZone`	`getTimeZone()`
`boolean`	`isEncloseParamInParentheses()`
`boolean`	`isMarked()`
`boolean`	`isOracleMode()`
`void`	`mark()`
`void`	`permitTrace(boolean permitTrace)`
`byte[]`	`resetMark()` Reset mark flag and send bytes after mark flag.
`abstract void`	`setMaxAllowedPacket(int maxAllowedPacket)`
`void`	`setOracleMode(boolean oracleMode)`
`void`	`setPosition(int val)` Set current position
`void`	`setServerThreadId(long serverThreadId, Boolean isMaster)` Set server thread id.
`void`	`setTimeZone(TimeZone tm)`
`void`	`setTraceCache(LruTraceCache traceCache)`
`abstract void`	`startPacket(int seqNo)`
`void`	`startSendRequest()`
`void`	`write(byte[] arr)`
`void`	`write(byte[] arr, int off, int len)` Write byte array to buffer.
`void`	`write(InputStream is, boolean escape, boolean noBackslashEscapes)` Write stream into socket.
`void`	`write(InputStream is, long length, boolean escape, boolean noBackslashEscapes)` Write stream into socket.
`void`	`write(int value)` Write byte into buffer, flush buffer to socket if needed.
`void`	`write(Reader reader, boolean escape, boolean noBackslashEscapes)` Write reader into socket.
`void`	`write(Reader reader, long length, boolean escape, boolean noBackslashEscapes)` Write reader into socket.
`void`	`write(String str)`
`void`	`write(String str, boolean escape, boolean noBackslashEscapes)` Write string to socket.
`void`	`writeBytes(byte value, int len)` Write byte value, len times into buffer. flush buffer if too small.
`void`	`writeBytesEscaped(byte[] bytes, int len, boolean noBackslashEscapes)` Write escape bytes to socket.
`void`	`writeBytesEscapedQuote(byte[] bytes, int len, boolean noBackslashEscapes)` Write escape bytes to socket.
`abstract void`	`writeEmptyPacket()`
`void`	`writeEmptyPacket(int seqNo)` Send empty packet.
`void`	`writeEscapeQuote(Reader reader, boolean noBackslashEscapes)`
`void`	`writeEscapeQuote(Reader reader, long length, boolean noBackslashEscapes)`
`void`	`writeFieldLength(long length)` Write field length into buffer, flush socket if needed.
`void`	`writeFloatV1(float f)`
`void`	`writeHex(InputStream is, boolean escape, boolean noBackslashEscapes)` Write stream AS hexdump into socket.
`void`	`writeHex(InputStream is, long length, boolean escape, boolean noBackslashEscapes)` Write stream As hexdump into socket.
`void`	`writeInt(int value)` Write int value into buffer. flush buffer if too small.
`void`	`writeIntV1(int i)` writeInt operation for jdbc 1.x
`void`	`writeLong(long value)` Write long value into buffer. flush buffer if too small.
`void`	`writeLongV1(long i)` writeLong operation for jdbc 1.x
`void`	`writeShort(short value)` Write short value into buffer. flush buffer if too small.

从类继承的方法 java.io.FilterOutputStream
close

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.oceanbase.jdbc.internal.io.output.PacketOutputStream
close, initialPacketPos

- 字段详细资料
  - threadId
```
protected long threadId
```
  - mysqlSeqNo
```
protected int mysqlSeqNo
```
  - traceCache
```
protected LruTraceCache traceCache
```
  - serverThreadLog
```
protected String serverThreadLog
```
  - maxQuerySizeToLog
```
protected final int maxQuerySizeToLog
```
  - enableNetworkStatistics
```
protected boolean enableNetworkStatistics
```
  - timestampBeforeFlush
```
protected long timestampBeforeFlush
```
  - buf
```
protected byte[] buf
```
  - pos
```
protected int pos
```
    relative position in mysql payload
  - cmdLength
```
protected long cmdLength
```
  - maxPacketLength
```
protected int maxPacketLength
```
  - maxAllowedPacket
```
protected int maxAllowedPacket
```
  - permitTrace
```
protected boolean permitTrace
```
  - charset
```
protected Charset charset
```
- 构造器详细资料
  - AbstractPacketOutputStream
```
public AbstractPacketOutputStream(OutputStream out,
                                  int maxQuerySizeToLog,
                                  long threadId,
                                  String encoding,
                                  TimeTrace timeTrace,
                                  boolean encloseParamInParentheses)
```
    Common feature to write data into socket, creating MariaDB Packet.
    
    参数:
    
    out - socket outputStream
    
    maxQuerySizeToLog - maximum query size to log
    
    threadId - thread id
- 方法详细资料
  - setTimeZone
```
public void setTimeZone(TimeZone tm)
```
    指定者:
    
    setTimeZone 在接口中 PacketOutputStream
  - getTimeZone
```
public TimeZone getTimeZone()
```
    指定者:
    
    getTimeZone 在接口中 PacketOutputStream
  - getMaxPacketLength
```
public int getMaxPacketLength()
```
  - startPacket
```
public abstract void startPacket(int seqNo)
```
    指定者:
    
    startPacket 在接口中 PacketOutputStream
  - enableNetworkStatistics
```
public void enableNetworkStatistics(boolean flag)
```
    指定者:
    
    enableNetworkStatistics 在接口中 PacketOutputStream
  - getTimestampBeforeFlush
```
public long getTimestampBeforeFlush()
```
    指定者:
    
    getTimestampBeforeFlush 在接口中 PacketOutputStream
  - clearNetworkStatistics
```
public void clearNetworkStatistics()
```
    指定者:
    
    clearNetworkStatistics 在接口中 PacketOutputStream
  - getCharset
```
public Charset getCharset()
```
    指定者:
    
    getCharset 在接口中 PacketOutputStream
  - flushBuffer
```
protected abstract void flushBuffer(boolean commandEnd)
                             throws IOException
```
    抛出:
    
    IOException
  - writeEmptyPacket
```
public void writeEmptyPacket(int seqNo)
                      throws IOException
```
    Send empty packet.
    
    指定者:
    
    writeEmptyPacket 在接口中 PacketOutputStream
    
    参数:
    
    seqNo - packet sequence
    
    抛出:
    
    IOException - if socket error occur.
  - writeEmptyPacket
```
public abstract void writeEmptyPacket()
                               throws IOException
```
    指定者:
    
    writeEmptyPacket 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - flush
```
public void flush()
           throws IOException
```
    Send packet to socket.
    
    指定者:
    
    flush 在接口中 PacketOutputStream
    
    指定者:
    
    flush 在接口中 Flushable
    
    覆盖:
    
    flush 在类中 FilterOutputStream
    
    抛出:
    
    IOException - if socket error occur.
  - flushLoadDataLocalFile
```
public void flushLoadDataLocalFile()
                            throws IOException
```
    指定者:
    
    flushLoadDataLocalFile 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - doFlush
```
public void doFlush()
             throws IOException
```
    抛出:
    
    IOException
  - checkRemainingSize
```
public boolean checkRemainingSize(int len)
```
    指定者:
    
    checkRemainingSize 在接口中 PacketOutputStream
  - checkMaxAllowedLength
```
public void checkMaxAllowedLength(int length)
                           throws MaxAllowedPacketException
```
    Count query size. If query size is greater than max_allowed_packet and nothing has been already send, throw an exception to avoid having the connection closed.
    
    指定者:
    
    checkMaxAllowedLength 在接口中 PacketOutputStream
    
    参数:
    
    length - additional length to query size
    
    抛出:
    
    MaxAllowedPacketException - if query has not to be send.
  - exceedMaxLength
```
public boolean exceedMaxLength()
```
    指定者:
    
    exceedMaxLength 在接口中 PacketOutputStream
  - getOutputStream
```
public OutputStream getOutputStream()
```
    指定者:
    
    getOutputStream 在接口中 PacketOutputStream
  - writeShort
```
public void writeShort(short value)
                throws IOException
```
    Write short value into buffer. flush buffer if too small.
    
    指定者:
    
    writeShort 在接口中 PacketOutputStream
    
    参数:
    
    value - short value
    
    抛出:
    
    IOException - if socket error occur
  - writeIntV1
```
public final void writeIntV1(int i)
                      throws IOException
```
    writeInt operation for jdbc 1.x
    
    指定者:
    
    writeIntV1 在接口中 PacketOutputStream
    
    参数:
    
    i -
    
    抛出:
    
    IOException
  - writeInt
```
public void writeInt(int value)
              throws IOException
```
    Write int value into buffer. flush buffer if too small.
    
    指定者:
    
    writeInt 在接口中 PacketOutputStream
    
    参数:
    
    value - int value
    
    抛出:
    
    IOException - if socket error occur
  - writeFloatV1
```
public void writeFloatV1(float f)
                  throws IOException
```
    指定者:
    
    writeFloatV1 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - writeLong
```
public void writeLong(long value)
               throws IOException
```
    Write long value into buffer. flush buffer if too small.
    
    指定者:
    
    writeLong 在接口中 PacketOutputStream
    
    参数:
    
    value - long value
    
    抛出:
    
    IOException - if socket error occur
  - writeLongV1
```
public void writeLongV1(long i)
                 throws IOException
```
    writeLong operation for jdbc 1.x
    
    指定者:
    
    writeLongV1 在接口中 PacketOutputStream
    
    参数:
    
    i -
    
    抛出:
    
    IOException
  - writeBytes
```
public void writeBytes(byte value,
                       int len)
                throws IOException
```
    Write byte value, len times into buffer. flush buffer if too small.
    
    指定者:
    
    writeBytes 在接口中 PacketOutputStream
    
    参数:
    
    value - byte value
    
    len - number of time to write value.
    
    抛出:
    
    IOException - if socket error occur.
  - writeFieldLength
```
public void writeFieldLength(long length)
                      throws IOException
```
    Write field length into buffer, flush socket if needed.
    
    指定者:
    
    writeFieldLength 在接口中 PacketOutputStream
    
    参数:
    
    length - field length
    
    抛出:
    
    IOException - if socket error occur.
  - write
```
public void write(int value)
           throws IOException
```
    Write byte into buffer, flush buffer to socket if needed.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    覆盖:
    
    write 在类中 FilterOutputStream
    
    参数:
    
    value - byte to send
    
    抛出:
    
    IOException - if socket error occur.
  - write
```
public void write(byte[] arr)
           throws IOException
```
    指定者:
    
    write 在接口中 PacketOutputStream
    
    覆盖:
    
    write 在类中 FilterOutputStream
    
    抛出:
    
    IOException
  - write
```
public void write(byte[] arr,
                  int off,
                  int len)
           throws IOException
```
    Write byte array to buffer. If buffer is full, flush socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    覆盖:
    
    write 在类中 FilterOutputStream
    
    参数:
    
    arr - byte array
    
    off - offset
    
    len - byte length to write
    
    抛出:
    
    IOException - if socket error occur
  - write
```
public void write(String str)
           throws IOException
```
    指定者:
    
    write 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - write
```
public void write(String str,
                  boolean escape,
                  boolean noBackslashEscapes)
           throws IOException
```
    Write string to socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    参数:
    
    str - string
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - write
```
public void write(InputStream is,
                  boolean escape,
                  boolean noBackslashEscapes)
           throws IOException
```
    Write stream into socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    参数:
    
    is - inputStream
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - writeHex
```
public void writeHex(InputStream is,
                     boolean escape,
                     boolean noBackslashEscapes)
              throws IOException
```
    Write stream AS hexdump into socket.
    
    指定者:
    
    writeHex 在接口中 PacketOutputStream
    
    参数:
    
    is - inputStream
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - write
```
public void write(InputStream is,
                  long length,
                  boolean escape,
                  boolean noBackslashEscapes)
           throws IOException
```
    Write stream into socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    参数:
    
    is - inputStream
    
    length - write length
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - writeHex
```
public void writeHex(InputStream is,
                     long length,
                     boolean escape,
                     boolean noBackslashEscapes)
              throws IOException
```
    Write stream As hexdump into socket.
    
    指定者:
    
    writeHex 在接口中 PacketOutputStream
    
    参数:
    
    is - inputStream
    
    length - write length
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - write
```
public void write(Reader reader,
                  boolean escape,
                  boolean noBackslashEscapes)
           throws IOException
```
    Write reader into socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    参数:
    
    reader - reader
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - writeEscapeQuote
```
public void writeEscapeQuote(Reader reader,
                             boolean noBackslashEscapes)
                      throws IOException
```
    指定者:
    
    writeEscapeQuote 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - writeEscapeQuote
```
public void writeEscapeQuote(Reader reader,
                             long length,
                             boolean noBackslashEscapes)
                      throws IOException
```
    指定者:
    
    writeEscapeQuote 在接口中 PacketOutputStream
    
    抛出:
    
    IOException
  - write
```
public void write(Reader reader,
                  long length,
                  boolean escape,
                  boolean noBackslashEscapes)
           throws IOException
```
    Write reader into socket.
    
    指定者:
    
    write 在接口中 PacketOutputStream
    
    参数:
    
    reader - reader
    
    length - write length
    
    escape - must be escape
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - writeBytesEscaped
```
public void writeBytesEscaped(byte[] bytes,
                              int len,
                              boolean noBackslashEscapes)
                       throws IOException
```
    Write escape bytes to socket.
    
    指定者:
    
    writeBytesEscaped 在接口中 PacketOutputStream
    
    参数:
    
    bytes - bytes
    
    len - len to write
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - writeBytesEscapedQuote
```
public void writeBytesEscapedQuote(byte[] bytes,
                                   int len,
                                   boolean noBackslashEscapes)
                            throws IOException
```
    Write escape bytes to socket.
    
    指定者:
    
    writeBytesEscapedQuote 在接口中 PacketOutputStream
    
    参数:
    
    bytes - bytes
    
    len - len to write
    
    noBackslashEscapes - escape method
    
    抛出:
    
    IOException - if socket error occur
  - getMaxAllowedPacket
```
public int getMaxAllowedPacket()
```
    指定者:
    
    getMaxAllowedPacket 在接口中 PacketOutputStream
  - setMaxAllowedPacket
```
public abstract void setMaxAllowedPacket(int maxAllowedPacket)
```
    指定者:
    
    setMaxAllowedPacket 在接口中 PacketOutputStream
  - permitTrace
```
public void permitTrace(boolean permitTrace)
```
    指定者:
    
    permitTrace 在接口中 PacketOutputStream
  - setServerThreadId
```
public void setServerThreadId(long serverThreadId,
                              Boolean isMaster)
```
    Set server thread id.
    
    指定者:
    
    setServerThreadId 在接口中 PacketOutputStream
    
    参数:
    
    serverThreadId - current server thread id.
    
    isMaster - is server master
  - setTraceCache
```
public void setTraceCache(LruTraceCache traceCache)
```
    指定者:
    
    setTraceCache 在接口中 PacketOutputStream
  - mark
```
public void mark()
```
    指定者:
    
    mark 在接口中 PacketOutputStream
  - isMarked
```
public boolean isMarked()
```
    指定者:
    
    isMarked 在接口中 PacketOutputStream
  - flushBufferStopAtMark
```
public void flushBufferStopAtMark()
                           throws IOException
```
    Flush to last mark.
    
    指定者:
    
    flushBufferStopAtMark 在接口中 PacketOutputStream
    
    抛出:
    
    IOException - if flush fail.
  - bufferIsDataAfterMark
```
public boolean bufferIsDataAfterMark()
```
    指定者:
    
    bufferIsDataAfterMark 在接口中 PacketOutputStream
  - resetMark
```
public byte[] resetMark()
```
    Reset mark flag and send bytes after mark flag.
    
    指定者:
    
    resetMark 在接口中 PacketOutputStream
    
    返回:
    
    bytes after mark flag
  - getPosition
```
public int getPosition()
```
    Get current position
    
    指定者:
    
    getPosition 在接口中 PacketOutputStream
    
    返回:
    
    position value
  - setPosition
```
public void setPosition(int val)
```
    Set current position
    
    指定者:
    
    setPosition 在接口中 PacketOutputStream
    
    参数:
    
    val - set current position vallue to val
  - startSendRequest
```
public void startSendRequest()
```
  - endSendRequest
```
public void endSendRequest()
```
  - isEncloseParamInParentheses
```
public boolean isEncloseParamInParentheses()
```
    指定者:
    
    isEncloseParamInParentheses 在接口中 PacketOutputStream
  - isOracleMode
```
public boolean isOracleMode()
```
    指定者:
    
    isOracleMode 在接口中 PacketOutputStream
  - setOracleMode
```
public void setOracleMode(boolean oracleMode)
```
    指定者:
    
    setOracleMode 在接口中 PacketOutputStream

类 AbstractPacketOutputStream

字段概要

从类继承的字段 java.io.FilterOutputStream

构造器概要

方法概要

从类继承的方法 java.io.FilterOutputStream

从类继承的方法 java.lang.Object

从接口继承的方法 com.oceanbase.jdbc.internal.io.output.PacketOutputStream

字段详细资料

threadId

mysqlSeqNo

traceCache

serverThreadLog

maxQuerySizeToLog

enableNetworkStatistics

timestampBeforeFlush

buf

pos

cmdLength

maxPacketLength

maxAllowedPacket

permitTrace

charset

构造器详细资料

AbstractPacketOutputStream

方法详细资料

setTimeZone

getTimeZone

getMaxPacketLength

startPacket

enableNetworkStatistics

getTimestampBeforeFlush

clearNetworkStatistics

getCharset

flushBuffer

writeEmptyPacket

writeEmptyPacket

flush

flushLoadDataLocalFile

doFlush

checkRemainingSize

checkMaxAllowedLength

exceedMaxLength

getOutputStream

writeShort

writeIntV1

writeInt

writeFloatV1

writeLong

writeLongV1

writeBytes

writeFieldLength

write

write

write

write

write

write

writeHex

write

writeHex

write

writeEscapeQuote

writeEscapeQuote

write

writeBytesEscaped

writeBytesEscapedQuote

getMaxAllowedPacket

setMaxAllowedPacket

permitTrace

setServerThreadId

setTraceCache

mark

isMarked

flushBufferStopAtMark

bufferIsDataAfterMark

resetMark

getPosition

setPosition

startSendRequest