SocketAsyncEventArgs.SetBuffer Метод

Определение

Пространство имен:

System.Net.Sockets

Сборки:

netstandard.dll, System.Net.Sockets.dll

Инициализирует буфер данных для использования с асинхронным методом сокета.

Перегрузки

Имя	Описание
SetBuffer(Memory<Byte>)	Задает область памяти, используемую в качестве буфера с асинхронным методом сокета.
SetBuffer(Int32, Int32)	Задает буфер данных для использования с асинхронным методом сокета.
SetBuffer(Byte[], Int32, Int32)	Задает буфер данных для использования с асинхронным методом сокета.

Комментарии

Этот метод задает Buffer для свойства значение NULL, а Count свойства равным Offset нулю.

SetBuffer(Memory<Byte>)

Исходный код:

SocketAsyncEventArgs.cs

Задает область памяти, используемую в качестве буфера с асинхронным методом сокета.

public:
 void SetBuffer(Memory<System::Byte> buffer);

public void SetBuffer(Memory<byte> buffer);

member this.SetBuffer : Memory<byte> -> unit

Public Sub SetBuffer (buffer As Memory(Of Byte))

Параметры

buffer

Memory<Byte>

Область памяти, используемая в качестве буфера с асинхронным методом сокета.

Комментарии

Этот метод задает MemoryBuffer свойство параметру, Count свойству bufferbuffer длину и Offset свойству нулю.

SetBuffer(Int32, Int32)

Исходный код:

SocketAsyncEventArgs.cs

Задает буфер данных для использования с асинхронным методом сокета.

public:
 void SetBuffer(int offset, int count);

public void SetBuffer(int offset, int count);

member this.SetBuffer : int * int -> unit

Public Sub SetBuffer (offset As Integer, count As Integer)

Параметры

offset

Int32

Смещение в байтах в буфере данных, где начинается операция.

count

Int32

Максимальный объем данных в байтах для отправки или получения в буфере.

Исключения

ArgumentOutOfRangeException

Аргумент был вне диапазона. Это исключение возникает, если offset параметр меньше нуля или больше длины массива в свойстве Buffer . Это исключение также возникает, если count параметр меньше нуля или больше длины массива в Buffer свойстве минус offset параметр.

Комментарии

Значения offset и count параметры не могут быть отрицательными числами. offset Сочетание параметров и count параметров должно находиться в границах буферного массива в свойствеBuffer.

Этот метод задает Count свойство count параметру и Offset свойству параметру offset . Buffer Если свойство равно null, этот метод игнорирует offset и count параметры и задает Offset значение 0 и Count свойства.

Этот метод не изменяет Buffer свойство.

См. также раздел

• Buffer
• Count
• Offset

SetBuffer(Byte[], Int32, Int32)

Исходный код:

SocketAsyncEventArgs.cs

Задает буфер данных для использования с асинхронным методом сокета.

public:
 void SetBuffer(cli::array <System::Byte> ^ buffer, int offset, int count);

public void SetBuffer(byte[]? buffer, int offset, int count);

member this.SetBuffer : byte[] * int * int -> unit

Public Sub SetBuffer (buffer As Byte(), offset As Integer, count As Integer)

Параметры

buffer

Byte[]

Буфер данных, используемый с асинхронным методом сокета.

offset

Int32

Смещение в байтах в буфере данных, где начинается операция.

count

Int32

Максимальный объем данных в байтах для отправки или получения в буфере.

Исключения

ArgumentException

Указаны неоднозначные буферы. Это исключение возникает, если Buffer свойство также не равно NULL, а BufferList свойство также не равно NULL.

ArgumentOutOfRangeException

Аргумент был вне диапазона. Это исключение возникает, если offset параметр меньше нуля или больше длины массива в свойстве Buffer . Это исключение также возникает, если count параметр меньше нуля или больше длины массива в Buffer свойстве минус offset параметр.

Примеры

В следующем примере кода создается один большой буфер, который можно разделить и назначить SocketAsyncEventArgs объектам для использования с каждой операцией ввода-вывода сокета. Это позволяет буферам легко использовать повторное использование и защиту от фрагментирования кучи памяти.

// This class creates a single large buffer which can be divided up
// and assigned to SocketAsyncEventArgs objects for use with each
// socket I/O operation.
// This enables bufffers to be easily reused and guards against
// fragmenting heap memory.
//
// The operations exposed on the BufferManager class are not thread safe.
class BufferManager
{
    int m_numBytes;                 // the total number of bytes controlled by the buffer pool
    byte[] m_buffer;                // the underlying byte array maintained by the Buffer Manager
    Stack<int> m_freeIndexPool;     //
    int m_currentIndex;
    int m_bufferSize;

    public BufferManager(int totalBytes, int bufferSize)
    {
        m_numBytes = totalBytes;
        m_currentIndex = 0;
        m_bufferSize = bufferSize;
        m_freeIndexPool = new Stack<int>();
    }

    // Allocates buffer space used by the buffer pool
    public void InitBuffer()
    {
        // create one big large buffer and divide that
        // out to each SocketAsyncEventArg object
        m_buffer = new byte[m_numBytes];
    }

    // Assigns a buffer from the buffer pool to the
    // specified SocketAsyncEventArgs object
    //
    // <returns>true if the buffer was successfully set, else false</returns>
    public bool SetBuffer(SocketAsyncEventArgs args)
    {

        if (m_freeIndexPool.Count > 0)
        {
            args.SetBuffer(m_buffer, m_freeIndexPool.Pop(), m_bufferSize);
        }
        else
        {
            if ((m_numBytes - m_bufferSize) < m_currentIndex)
            {
                return false;
            }
            args.SetBuffer(m_buffer, m_currentIndex, m_bufferSize);
            m_currentIndex += m_bufferSize;
        }
        return true;
    }

    // Removes the buffer from a SocketAsyncEventArg object.
    // This frees the buffer back to the buffer pool
    public void FreeBuffer(SocketAsyncEventArgs args)
    {
        m_freeIndexPool.Push(args.Offset);
        args.SetBuffer(null, 0, 0);
    }
}

Комментарии

Значения offset и count параметры не могут быть отрицательными числами. Сочетание offset параметров и count параметров должно быть привязано к массиву данных в параметре buffer .

Этот метод задает Buffer свойство buffer параметру, Count свойству count параметру и Offset свойству offset для параметра.

См. также раздел

• Buffer
• Count
• Offset