Class NpgsqlReadBuffer
A buffer used by Npgsql to read data from the socket efficiently.
Provides methods which decode different values types and tracks the current position.
Inheritance
System.Object
NpgsqlReadBuffer
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Npgsql.dll
Syntax
public sealed class NpgsqlReadBuffer
Properties
Connection
Declaration
public NpgsqlConnection Connection { get; }
Property Value
Methods
Ensure(Int32, Boolean)
Ensures that count
bytes are available in the buffer, and if
not, reads from the socket until enough is available.
Declaration
public Task Ensure(int count, bool async)
Parameters
Type |
Name |
Description |
System.Int32 |
count |
|
System.Boolean |
async |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
GetStream(Int32, Boolean)
Declaration
public Stream GetStream(int len, bool canSeek)
Parameters
Type |
Name |
Description |
System.Int32 |
len |
|
System.Boolean |
canSeek |
|
Returns
Type |
Description |
System.IO.Stream |
|
ReadByte()
Declaration
Returns
Type |
Description |
System.Byte |
|
ReadBytes(Byte[], Int32, Int32)
Declaration
public void ReadBytes(byte[] output, int outputOffset, int len)
Parameters
Type |
Name |
Description |
System.Byte[] |
output |
|
System.Int32 |
outputOffset |
|
System.Int32 |
len |
|
ReadBytes(Byte[], Int32, Int32, Boolean)
Declaration
public ValueTask<int> ReadBytes(byte[] output, int outputOffset, int len, bool async)
Parameters
Type |
Name |
Description |
System.Byte[] |
output |
|
System.Int32 |
outputOffset |
|
System.Int32 |
len |
|
System.Boolean |
async |
|
Returns
Type |
Description |
System.Threading.Tasks.ValueTask<System.Int32> |
|
ReadBytes(Span<Byte>)
Declaration
public void ReadBytes(Span<byte> output)
Parameters
Type |
Name |
Description |
System.Span<System.Byte> |
output |
|
ReadChars(Int32)
Declaration
public char[] ReadChars(int byteLen)
Parameters
Type |
Name |
Description |
System.Int32 |
byteLen |
|
Returns
Type |
Description |
System.Char[] |
|
ReadDouble()
Declaration
public double ReadDouble()
Returns
Type |
Description |
System.Double |
|
ReadDouble(Boolean)
Declaration
public double ReadDouble(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.Double |
|
ReadInt16()
Declaration
Returns
Type |
Description |
System.Int16 |
|
ReadInt16(Boolean)
Declaration
public short ReadInt16(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.Int16 |
|
ReadInt32()
Declaration
Returns
Type |
Description |
System.Int32 |
|
ReadInt32(Boolean)
Declaration
public int ReadInt32(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.Int32 |
|
ReadInt64()
Declaration
Returns
Type |
Description |
System.Int64 |
|
ReadInt64(Boolean)
Declaration
public long ReadInt64(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.Int64 |
|
ReadNullTerminatedString()
Seeks the first null terminator (\0) and returns the string up to it. The buffer must already
contain the entire string and its terminator.
Declaration
public string ReadNullTerminatedString()
Returns
Type |
Description |
System.String |
|
ReadSByte()
Declaration
Returns
Type |
Description |
System.SByte |
|
ReadSingle()
Declaration
public float ReadSingle()
Returns
Type |
Description |
System.Single |
|
ReadSingle(Boolean)
Declaration
public float ReadSingle(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.Single |
|
ReadString(Int32)
Declaration
public string ReadString(int byteLen)
Parameters
Type |
Name |
Description |
System.Int32 |
byteLen |
|
Returns
Type |
Description |
System.String |
|
ReadUInt16()
Declaration
public ushort ReadUInt16()
Returns
Type |
Description |
System.UInt16 |
|
ReadUInt16(Boolean)
Declaration
public ushort ReadUInt16(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.UInt16 |
|
ReadUInt32()
Declaration
Returns
Type |
Description |
System.UInt32 |
|
ReadUInt32(Boolean)
Declaration
public uint ReadUInt32(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.UInt32 |
|
ReadUInt64()
Declaration
public ulong ReadUInt64()
Returns
Type |
Description |
System.UInt64 |
|
ReadUInt64(Boolean)
Declaration
public ulong ReadUInt64(bool littleEndian)
Parameters
Type |
Name |
Description |
System.Boolean |
littleEndian |
|
Returns
Type |
Description |
System.UInt64 |
|
Skip(Int64, Boolean)
Skip a given number of bytes.
Declaration
public Task Skip(long len, bool async)
Parameters
Type |
Name |
Description |
System.Int64 |
len |
|
System.Boolean |
async |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|