Socket.EndReceive Method

Definition

Завершает отложенное асинхронное чтение.Ends a pending asynchronous read.

Overloads

EndReceive(IAsyncResult)

Завершает отложенное асинхронное чтение.Ends a pending asynchronous read.

EndReceive(IAsyncResult, SocketError)

Завершает отложенное асинхронное чтение.Ends a pending asynchronous read.

EndReceive(IAsyncResult)

Завершает отложенное асинхронное чтение.Ends a pending asynchronous read.

public:
 int EndReceive(IAsyncResult ^ asyncResult);
public:
 int EndReceive(IAsyncResult ^ result);
public int EndReceive (IAsyncResult asyncResult);
public int EndReceive (IAsyncResult result);
member this.EndReceive : IAsyncResult -> int
member this.EndReceive : IAsyncResult -> int
Public Function EndReceive (asyncResult As IAsyncResult) As Integer
Public Function EndReceive (result As IAsyncResult) As Integer

Parameters

asyncResultresult
IAsyncResult

Объект IAsyncResult, в котором хранятся сведения о состоянии и любые данные, определенные пользователем, для этой асинхронной операции.An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

Returns

Int32

Количество полученных байтов.The number of bytes received.

Exceptions

Параметр asyncResult равен null.asyncResult is null.

Параметр asyncResult не был возвращен вызовом метода BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).asyncResult was not returned by a call to the BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) method.

Метод EndReceive(IAsyncResult) был ранее вызван для асинхронного чтения.EndReceive(IAsyncResult) was previously called for the asynchronous read.

Произошла ошибка при попытке доступа к сокету.An error occurred when attempting to access the socket.

Socket был закрыт.The Socket has been closed.

Examples

В следующем примере кода завершается ожидание асинхронного чтения.The following code example ends a pending asynchronous read. Полный пример, демонстрирующий асинхронную связь с сокетами, см. в статье примеры кода для сокетов.For a complete example that demonstrates asynchronous communications with sockets, see Socket Code Examples.

static void Read_Callback( IAsyncResult^ ar )
{
   StateObject^ so = safe_cast<StateObject^>(ar->AsyncState);
   Socket^ s = so->workSocket;

   int read = s->EndReceive( ar );

   if ( read > 0 )
   {
      so->sb->Append( Encoding::ASCII->GetString( so->buffer, 0, read ) );
      s->BeginReceive( so->buffer, 0, StateObject::BUFFER_SIZE, SocketFlags::None,
         gcnew AsyncCallback( &Async_Send_Receive::Read_Callback ), so );
   }
   else
   {
      if ( so->sb->Length > 1 )
      {
         //All of the data has been read, so displays it to the console
         String^ strContent = so->sb->ToString();
         Console::WriteLine( String::Format( "Read {0} byte from socket" +
            " data = {1} ", strContent->Length, strContent ) );
      }
      s->Close();
   }
}
public static void Read_Callback(IAsyncResult ar){
    StateObject so = (StateObject) ar.AsyncState;
    Socket s = so.workSocket;

    int read = s.EndReceive(ar);

    if (read > 0) {
            so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read));
            s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0,
                                     new AsyncCallback(Async_Send_Receive.Read_Callback), so);
    }
    else{
         if (so.sb.Length > 1) {
              //All of the data has been read, so displays it to the console
              string strContent;
              strContent = so.sb.ToString();
              Console.WriteLine(String.Format("Read {0} byte from socket" +
                               "data = {1} ", strContent.Length, strContent));
         }
         s.Close();
    }
}
Public Shared Sub Read_Callback(ar As IAsyncResult)
   Dim so As StateObject = CType(ar.AsyncState, StateObject)
   Dim s As Socket = so.workSocket
   
   Dim read As Integer = s.EndReceive(ar)
   
   If read > 0 Then
      so.sb.Append(Encoding.ASCII.GetString(so.buffer, 0, read))
      s.BeginReceive(so.buffer, 0, StateObject.BUFFER_SIZE, 0, New AsyncCallback(AddressOf Async_Send_Receive.Read_Callback), so)
   Else
      If so.sb.Length > 1 Then
         'All the data has been read, so displays it to the console
         Dim strContent As String
         strContent = so.sb.ToString()
         Console.WriteLine([String].Format("Read {0} byte from socket" + "data = {1} ", strContent.Length, strContent))
      End If
      s.Close()
   End If
End Sub

Remarks

Метод EndReceive завершает операцию асинхронного чтения, запущенную в методе BeginReceive.The EndReceive method completes the asynchronous read operation started in the BeginReceive method.

Перед вызовом BeginReceiveнеобходимо создать метод обратного вызова, реализующий делегат AsyncCallback.Before calling BeginReceive, you need to create a callback method that implements the AsyncCallback delegate. Этот метод обратного вызова выполняется в отдельном потоке и вызывается системой после того, как BeginReceive возвращает.This callback method executes in a separate thread and is called by the system after BeginReceive returns. Метод обратного вызова должен принимать IAsyncResult, возвращаемый методом BeginReceive в качестве параметра.The callback method must accept the IAsyncResult returned by the BeginReceive method as a parameter.

В методе обратного вызова вызовите метод AsyncState IAsyncResult, чтобы получить объект состояния, переданный методу BeginReceive.Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceive method. Извлеките Socket получения из этого объекта состояния.Extract the receiving Socket from this state object. После получения Socketможно вызвать метод EndReceive для успешного завершения операции чтения и возврата числа считанных байтов.After obtaining the Socket, you can call the EndReceive method to successfully complete the read operation and return the number of bytes read.

Метод EndReceive будет блокироваться до тех пор, пока данные недоступны.The EndReceive method will block until data is available. Если используется протокол без установления соединения, EndReceive прочитает первую поставленную в очередь датаграмму, доступную во входящем сетевом буфере.If you are using a connectionless protocol, EndReceive will read the first enqueued datagram available in the incoming network buffer. При использовании протокола, ориентированного на соединение, метод EndReceive будет считывать столько данных, сколько доступно до числа байтов, указанных в параметре size метода BeginReceive.If you are using a connection-oriented protocol, the EndReceive method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceive method. Если удаленный узел завершает подключение Socket с помощью метода Shutdown и получены все доступные данные, метод EndReceive будет завершен немедленно и возвращать нулевые байты.If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the EndReceive method will complete immediately and return zero bytes.

Чтобы получить полученные данные, вызовите метод AsyncState IAsyncResultи извлеките буфер, содержащийся в результирующем объекте состояния.To obtain the received data, call the AsyncState method of the IAsyncResult, and extract the buffer contained in the resulting state object.

Чтобы отменить ожидающее BeginReceive, вызовите метод Close.To cancel a pending BeginReceive, call the Close method.

Note

Если вы получаете SocketException, используйте свойство SocketException.ErrorCode для получения конкретного кода ошибки.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. После получения этого кода обратитесь к документации по коду ошибки API Windows Sockets версии 2 для получения подробного описания ошибки.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

Все операции ввода-вывода, инициированные данным потоком, отменяются при выходе из этого потока.All I/O initiated by a given thread is canceled when that thread exits. Незавершенная асинхронная операция может завершиться ошибкой, если поток завершается до завершения операции.A pending asynchronous operation can fail if the thread exits before the operation completes.

Note

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети.This member outputs trace information when you enable network tracing in your application. Дополнительные сведения см. в разделе Сетевая трассировка в .NET Framework.For more information, see Network Tracing in the .NET Framework.

See also

EndReceive(IAsyncResult, SocketError)

Завершает отложенное асинхронное чтение.Ends a pending asynchronous read.

public:
 int EndReceive(IAsyncResult ^ asyncResult, [Runtime::InteropServices::Out] System::Net::Sockets::SocketError % errorCode);
public int EndReceive (IAsyncResult asyncResult, out System.Net.Sockets.SocketError errorCode);
member this.EndReceive : IAsyncResult * SocketError -> int
Public Function EndReceive (asyncResult As IAsyncResult, ByRef errorCode As SocketError) As Integer

Parameters

asyncResult
IAsyncResult

Объект IAsyncResult, в котором хранятся сведения о состоянии и любые данные, определенные пользователем, для этой асинхронной операции.An IAsyncResult that stores state information and any user defined data for this asynchronous operation.

errorCode
SocketError

Объект SocketError, содержащий ошибку сокета.A SocketError object that stores the socket error.

Returns

Int32

Количество полученных байтов.The number of bytes received.

Exceptions

Параметр asyncResult равен null.asyncResult is null.

Параметр asyncResult не был возвращен вызовом метода BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object).asyncResult was not returned by a call to the BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) method.

Метод EndReceive(IAsyncResult) был ранее вызван для асинхронного чтения.EndReceive(IAsyncResult) was previously called for the asynchronous read.

Произошла ошибка при попытке доступа к сокету.An error occurred when attempting to access the socket.

Socket был закрыт.The Socket has been closed.

Remarks

Метод EndReceive завершает операцию асинхронного чтения, запущенную в методе BeginReceive.The EndReceive method completes the asynchronous read operation started in the BeginReceive method.

Перед вызовом BeginReceiveнеобходимо создать метод обратного вызова, реализующий делегат AsyncCallback.Before calling BeginReceive, you need to create a callback method that implements the AsyncCallback delegate. Этот метод обратного вызова выполняется в отдельном потоке и вызывается системой после того, как BeginReceive возвращает.This callback method executes in a separate thread and is called by the system after BeginReceive returns. Метод обратного вызова должен принимать IAsyncResult, возвращаемый методом BeginReceive в качестве параметра.The callback method must accept the IAsyncResult returned by the BeginReceive method as a parameter.

В методе обратного вызова вызовите метод AsyncState IAsyncResult, чтобы получить объект состояния, переданный методу BeginReceive.Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceive method. Извлеките Socket получения из этого объекта состояния.Extract the receiving Socket from this state object. После получения Socketможно вызвать метод EndReceive для успешного завершения операции чтения и возврата числа считанных байтов.After obtaining the Socket, you can call the EndReceive method to successfully complete the read operation and return the number of bytes read.

Метод EndReceive будет блокироваться до тех пор, пока данные недоступны.The EndReceive method will block until data is available. Если используется протокол без установления соединения, EndReceive прочитает первую поставленную в очередь датаграмму, доступную во входящем сетевом буфере.If you are using a connectionless protocol, EndReceive will read the first enqueued datagram available in the incoming network buffer. При использовании протокола, ориентированного на соединение, метод EndReceive будет считывать столько данных, сколько доступно до числа байтов, указанных в параметре size метода BeginReceive.If you are using a connection-oriented protocol, the EndReceive method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceive method. Если удаленный узел завершает подключение Socket с помощью метода Shutdown и получены все доступные данные, метод EndReceive будет завершен немедленно и возвращать нулевые байты.If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the EndReceive method will complete immediately and return zero bytes.

Чтобы получить полученные данные, вызовите метод AsyncState IAsyncResultи извлеките буфер, содержащийся в результирующем объекте состояния.To obtain the received data, call the AsyncState method of the IAsyncResult, and extract the buffer contained in the resulting state object.

Note

Если вы получаете SocketException, используйте свойство SocketException.ErrorCode для получения конкретного кода ошибки.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. После получения этого кода обратитесь к документации по коду ошибки API Windows Sockets версии 2 для получения подробного описания ошибки.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

Все операции ввода-вывода, инициированные данным потоком, отменяются при выходе из этого потока.All I/O initiated by a given thread is canceled when that thread exits. Незавершенная асинхронная операция может завершиться ошибкой, если поток завершается до завершения операции.A pending asynchronous operation can fail if the thread exits before the operation completes.

Note

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети.This member outputs trace information when you enable network tracing in your application. Дополнительные сведения см. в разделе Сетевая трассировка в .NET Framework.For more information, see Network Tracing in the .NET Framework.

See also

Applies to