SocketAsyncEventArgs.OnCompleted(SocketAsyncEventArgs) Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Source:

SocketAsyncEventArgs.cs

Represents a method that is called when an asynchronous operation completes.

protected:
 virtual void OnCompleted(System::Net::Sockets::SocketAsyncEventArgs ^ e);

protected virtual void OnCompleted (System.Net.Sockets.SocketAsyncEventArgs e);

abstract member OnCompleted : System.Net.Sockets.SocketAsyncEventArgs -> unit
override this.OnCompleted : System.Net.Sockets.SocketAsyncEventArgs -> unit

Protected Overridable Sub OnCompleted (e As SocketAsyncEventArgs)

Parameters

e

SocketAsyncEventArgs

The event that is signaled.

Remarks

This method is not callable by user code. This method gets called by the internals of the SocketAsyncEventArgs object when the current operation is complete. This method is used with all asynchronous socket (xxxAsync) methods.

An application that creates a class inheriting from SocketAsyncEventArgs can override this method to hook into this completion notification and clean up any resources that it allocated for the operation. The default implementation just raises the Completed event.

This method is used to hook up an event handler to be used as the completion callback for a subsequent asynchronous socket operation. The caller must implement at least one callback delegate inherited from this method prior to starting an asynchronous socket operation using one of the asynchronous (xxxAsync) methods on the System.Net.Sockets.Socket class.

The caller's OnCompleted method provides a way for client applications to complete an asynchronous socket operation. A callback delegate must be implemented when an asynchronous socket operation is initiated. The completion callback delegate(s) inherited from the OnCompleted method must contain program logic to finish processing the asynchronous socket operation for the client.

When an asynchronous operation is signaled, the application uses the SocketAsyncEventArgs object parameter to obtain status of the completed asynchronous socket operation.

See also

• AcceptAsync(SocketAsyncEventArgs)
• ConnectAsync(SocketAsyncEventArgs)
• DisconnectAsync(SocketAsyncEventArgs)
• ReceiveAsync(SocketAsyncEventArgs)
• ReceiveFromAsync(SocketAsyncEventArgs)
• ReceiveMessageFromAsync(SocketAsyncEventArgs)
• SendAsync(SocketAsyncEventArgs)
• SendPacketsAsync(SocketAsyncEventArgs)
• SendToAsync(SocketAsyncEventArgs)