ByteBufCodedInputStream (Pulsar Common 2.7.2.10-rc-202109061352 API)

java.lang.Object
- org.apache.pulsar.common.util.protobuf.ByteBufCodedInputStream

public class ByteBufCodedInputStream
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ByteBufCodedInputStream.ByteBufMessageBuilder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ByteBufCodedInputStream.ByteBufMessageBuilder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkLastTagWas(int value)` Verifies that the last call to readTag() returned the given tag value.
`static ByteBufCodedInputStream`	`get(io.netty.buffer.ByteBuf buf)`
`int`	`getBytesUntilLimit()`
`boolean`	`isAtEnd()`
`void`	`popLimit(int oldLimit)` Discards the current limit, returning to the previous limit.
`int`	`pushLimit(int byteLimit)`
`boolean`	`readBool()` Read a `bool` field value from the stream.
`org.apache.pulsar.shaded.com.google.protobuf.v241.ByteString`	`readBytes()` Read a `bytes` field value from the stream.
`double`	`readDouble()` Read a `double` field value from the stream.
`int`	`readEnum()` Read an enum field value from the stream.
`int`	`readFixed32()` Read a `fixed32` field value from the stream.
`long`	`readFixed64()` Read a `fixed64` field value from the stream.
`float`	`readFloat()` Read a `float` field value from the stream.
`int`	`readInt32()` Read an `int32` field value from the stream.
`long`	`readInt64()` Read an `int64` field value from the stream.
`void`	`readMessage(ByteBufCodedInputStream.ByteBufMessageBuilder builder, org.apache.pulsar.shaded.com.google.protobuf.v241.ExtensionRegistryLite extensionRegistry)` Read an embedded message field value from the stream.
`int`	`readRawLittleEndian32()` Read a 32-bit little-endian integer from the stream.
`long`	`readRawLittleEndian64()` Read a 64-bit little-endian integer from the stream.
`int`	`readRawVarint32()` Read a raw Varint from the stream.
`long`	`readRawVarint64()` Read a raw Varint from the stream.
`long`	`readSFixed64()`
`int`	`readTag()`
`int`	`readUInt32()` Read a `uint32` field value from the stream.
`long`	`readUInt64()` Read a `uint64` field value from the stream.
`void`	`recycle()`
`boolean`	`skipField(int tag)` Reads and discards a single field, given its tag value.
`void`	`skipMessage()` Reads and discards an entire message.
`void`	`skipRawBytes(int size)` Reads and discards `size` bytes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - get
```
public static ByteBufCodedInputStream get(io.netty.buffer.ByteBuf buf)
```
  - recycle
```
public void recycle()
```
  - readTag
```
public int readTag()
            throws IOException
```
    Throws:
    
    IOException
  - readUInt32
```
public int readUInt32()
               throws IOException
```
    Read a uint32 field value from the stream.
    
    Throws:
    
    IOException
  - readEnum
```
public int readEnum()
             throws IOException
```
    Read an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.
    
    Throws:
    
    IOException
  - isAtEnd
```
public boolean isAtEnd()
                throws IOException
```
    Throws:
    
    IOException
  - readMessage
```
public void readMessage(ByteBufCodedInputStream.ByteBufMessageBuilder builder,
                        org.apache.pulsar.shaded.com.google.protobuf.v241.ExtensionRegistryLite extensionRegistry)
                 throws IOException
```
    Read an embedded message field value from the stream.
    
    Throws:
    
    IOException
  - readBytes
```
public org.apache.pulsar.shaded.com.google.protobuf.v241.ByteString readBytes()
                                                                       throws IOException
```
    Read a bytes field value from the stream.
    
    Throws:
    
    IOException
  - skipField
```
public boolean skipField(int tag)
                  throws IOException
```
    Reads and discards a single field, given its tag value.
    
    Returns:
    
    false if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returns true.
    
    Throws:
    
    IOException
  - checkLastTagWas
```
public void checkLastTagWas(int value)
                     throws org.apache.pulsar.shaded.com.google.protobuf.v241.InvalidProtocolBufferException
```
    Verifies that the last call to readTag() returned the given tag value. This is used to verify that a nested group ended with the correct end tag.
    
    Throws:
    
    org.apache.pulsar.shaded.com.google.protobuf.v241.InvalidProtocolBufferException - value does not match the last tag.
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Read a double field value from the stream.
    
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Read a float field value from the stream.
    
    Throws:
    
    IOException
  - readUInt64
```
public long readUInt64()
                throws IOException
```
    Read a uint64 field value from the stream.
    
    Throws:
    
    IOException
  - readInt64
```
public long readInt64()
               throws IOException
```
    Read an int64 field value from the stream.
    
    Throws:
    
    IOException
  - readInt32
```
public int readInt32()
              throws IOException
```
    Read an int32 field value from the stream.
    
    Throws:
    
    IOException
  - readFixed64
```
public long readFixed64()
                 throws IOException
```
    Read a fixed64 field value from the stream.
    
    Throws:
    
    IOException
  - readFixed32
```
public int readFixed32()
                throws IOException
```
    Read a fixed32 field value from the stream.
    
    Throws:
    
    IOException
  - readBool
```
public boolean readBool()
                 throws IOException
```
    Read a bool field value from the stream.
    
    Throws:
    
    IOException
  - readRawVarint64
```
public long readRawVarint64()
                     throws IOException
```
    Read a raw Varint from the stream.
    
    Throws:
    
    IOException
  - readRawVarint32
```
public int readRawVarint32()
                    throws IOException
```
    Read a raw Varint from the stream. If larger than 32 bits, discard the upper bits.
    
    Throws:
    
    IOException
  - readRawLittleEndian32
```
public int readRawLittleEndian32()
                          throws IOException
```
    Read a 32-bit little-endian integer from the stream.
    
    Throws:
    
    IOException
  - readRawLittleEndian64
```
public long readRawLittleEndian64()
                           throws IOException
```
    Read a 64-bit little-endian integer from the stream.
    
    Throws:
    
    IOException
  - readSFixed64
```
public long readSFixed64()
                  throws IOException
```
    Throws:
    
    IOException
  - skipMessage
```
public void skipMessage()
                 throws IOException
```
    Reads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.
    
    Throws:
    
    IOException
  - skipRawBytes
```
public void skipRawBytes(int size)
                  throws IOException
```
    Reads and discards size bytes.
    
    Throws:
    
    org.apache.pulsar.shaded.com.google.protobuf.v241.InvalidProtocolBufferException - The end of the stream or the current limit was reached.
    
    IOException
  - pushLimit
```
public int pushLimit(int byteLimit)
              throws org.apache.pulsar.shaded.com.google.protobuf.v241.InvalidProtocolBufferException
```
    Throws:
    
    org.apache.pulsar.shaded.com.google.protobuf.v241.InvalidProtocolBufferException
  - popLimit
```
public void popLimit(int oldLimit)
```
    Discards the current limit, returning to the previous limit.
    
    Parameters:
    
    oldLimit - The old limit, as returned by pushLimit.
  - getBytesUntilLimit
```
public int getBytesUntilLimit()
```

Class ByteBufCodedInputStream

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

recycle

readTag

readUInt32

readEnum

isAtEnd

readMessage

readBytes

skipField

checkLastTagWas

readDouble

readFloat

readUInt64

readInt64

readInt32

readFixed64

readFixed32

readBool

readRawVarint64

readRawVarint32

readRawLittleEndian32

readRawLittleEndian64

readSFixed64

skipMessage

skipRawBytes

pushLimit

popLimit

getBytesUntilLimit