Socket.ConnectAsync Método

Definição

Inicia uma solicitação assíncrona para uma conexão com um host remoto.Begins an asynchronous request for a connection to a remote host.

Sobrecargas

ConnectAsync(SocketAsyncEventArgs)

Inicia uma solicitação assíncrona para uma conexão com um host remoto.Begins an asynchronous request for a connection to a remote host.

ConnectAsync(SocketType, ProtocolType, SocketAsyncEventArgs)

Inicia uma solicitação assíncrona para uma conexão com um host remoto.Begins an asynchronous request for a connection to a remote host.

ConnectAsync(SocketAsyncEventArgs)

Inicia uma solicitação assíncrona para uma conexão com um host remoto.Begins an asynchronous request for a connection to a remote host.

public:
 bool ConnectAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);
public bool ConnectAsync (System.Net.Sockets.SocketAsyncEventArgs e);
member this.ConnectAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Function ConnectAsync (e As SocketAsyncEventArgs) As Boolean

Parâmetros

e
SocketAsyncEventArgs

O objeto SocketAsyncEventArgs a ser usado nessa operação de soquete assíncrono.The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Retornos

Boolean

true se a operação de E/S está pendente.true if the I/O operation is pending. O evento Completed no parâmetro e será acionado após a conclusão da operação.The Completed event on the e parameter will be raised upon completion of the operation.

false se a operação de E/S foi concluída de forma síncrona.false if the I/O operation completed synchronously. Nesse caso, o evento Completed no parâmetro e não será gerado e o objeto e passado como um parâmetro poderá ser examinado imediatamente depois que a chamada do método for retornada para recuperar o resultado da operação.In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exceções

Um argumento não é válido.An argument is not valid. Essa exceção ocorrerá se vários buffers forem especificados e a propriedade BufferList não for nula.This exception occurs if multiple buffers are specified, the BufferList property is not null.

O parâmetro e e o RemoteEndPoint não podem ser nulos.The e parameter cannot be null and the RemoteEndPoint cannot be null.

O Socket está escutando ou uma operação de soquete já estava em andamento usando o objeto SocketAsyncEventArgs especificado no parâmetro e.The Socket is listening or a socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

Ocorreu um erro ao tentar acessar o soquete.An error occurred when attempting to access the socket.

É necessário o Windows XP ou posterior para esse método.Windows XP or later is required for this method. Essa exceção também ocorrerá se o ponto de extremidade local e o RemoteEndPoint não forem da mesma família de endereços.This exception also occurs if the local endpoint and the RemoteEndPoint are not the same address family.

O Socket foi fechado.The Socket has been closed.

Um chamador mais alto na pilha de chamadas não tem permissão para a operação solicitada.A caller higher in the call stack does not have permission for the requested operation.

Comentários

Se você estiver usando um protocolo orientado a conexão, o ConnectAsync método iniciará uma solicitação assíncrona para uma conexão com o host remoto.If you are using a connection-oriented protocol, the ConnectAsync method starts an asynchronous request for a connection to the remote host. Se você estiver usando um protocolo sem conexão, ConnectAsync o estabelecerá um host remoto padrão.If you are using a connectionless protocol, ConnectAsync establishes a default remote host.

Para ser notificado da conclusão, você deve criar um método de retorno de chamada que implemente o <SocketAsyncEventArgs> delegado EventHandler e anexe o retorno de chamada ao SocketAsyncEventArgs.Completed evento.To be notified of completion, you must create a callback method that implements the EventHandler<SocketAsyncEventArgs> delegate and attach the callback to the SocketAsyncEventArgs.Completed event.

O chamador deve definir a SocketAsyncEventArgs.RemoteEndPoint propriedade como o IPEndPoint do host remoto ao qual se conectar.The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host to connect to.

O chamador pode definir a SocketAsyncEventArgs.UserToken propriedade para qualquer objeto de estado de usuário desejado antes de chamar o ConnectAsync método, de modo que as informações serão recuperáveis no método de retorno de chamada.The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ConnectAsync method, so that the information will be retrievable in the callback method. Se o retorno de chamada precisar de mais informações do que um único objeto, uma classe pequena poderá ser criada para manter as outras informações de estado necessárias como membros.If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.

Se você estiver usando um protocolo sem conexão, como o UDP, não precisará chamar ConnectAsync antes de enviar e receber dados.If you are using a connectionless protocol such as UDP, you do not have to call ConnectAsync before sending and receiving data. Você pode usar SendToAsync ReceiveFromAsync o e o para se comunicar com um host remoto.You can use SendToAsync and ReceiveFromAsync to communicate with a remote host. Se você chamar ConnectAsync , todos os datagramas que chegam de um endereço diferente do padrão especificado serão descartados.If you do call ConnectAsync, any datagrams that arrive from an address other than the specified default will be discarded. Se você quiser alterar o host remoto padrão, chame o ConnectAsync método novamente com o ponto de extremidade desejado.If you want to change the default remote host, call the ConnectAsync method again with the desired endpoint.

Se você quiser definir o host remoto padrão para um endereço de difusão, primeiro você deve chamar SetSocketOption e definir Broadcast para true .If you wish to set the default remote host to a broadcast address, you must first call SetSocketOption and set Broadcast to true. Se isso não for feito, o ConnectAsync método gerará um SocketException .If this is not done, the ConnectAsync method will throw a SocketException.

As seguintes propriedades e eventos no System.Net.Sockets.SocketAsyncEventArgs objeto são necessários:The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required:

Opcionalmente, pode ser fornecido um buffer que será enviado atomicamente no soquete depois que o ConnectAsync método for executado com sucesso.Optionally, a buffer may be provided which will atomically be sent on the socket after the ConnectAsync method succeeds. Nesse caso, a SocketAsyncEventArgs.Buffer propriedade precisa ser definida como o buffer que contém os dados a serem enviados e a SocketAsyncEventArgs.Count propriedade precisa ser definida como o número de bytes de dados a serem enviados do buffer.In this case, the SocketAsyncEventArgs.Buffer property needs to be set to the buffer containing the data to send and the SocketAsyncEventArgs.Count property needs to be set to the number of bytes of data to send from the buffer. Depois que uma conexão é estabelecida, esse buffer de dados é enviado.Once a connection is established, this buffer of data is sent.

Se você estiver usando um protocolo orientado a conexão e não chamar Bind antes ConnectAsync de chamar, o provedor de serviços subjacente atribuirá o número da porta e o endereço de rede local mais apropriado.If you are using a connection-oriented protocol and do not call Bind before calling ConnectAsync, the underlying service provider will assign the most appropriate local network address and port number.

Se você estiver usando um protocolo sem conexão, o provedor de serviços não atribuirá um endereço IP de rede local e um número de porta até que você chame os SendAsync ReceiveAsync métodos ou.If you are using a connectionless protocol, the service provider will not assign a local network IP address and port number until you call the SendAsync or ReceiveAsync methods.

O ConnectAsync método gera NotSupportedException se a família de endereços do Socket e o SocketAsyncEventArgs.RemoteEndPoint não são da mesma família de endereços.The ConnectAsync method throws NotSupportedException if the address family of the Socket and the SocketAsyncEventArgs.RemoteEndPoint are not the same address family.

Observação

Se você receber um SocketException ao chamar esse método, use a SocketException.ErrorCode propriedade para obter o código de erro específico.If you receive a SocketException when calling this method, use the SocketException.ErrorCode property to obtain the specific error code. Depois de obter esse código, consulte a documentação do código de erro da API do Windows Sockets versão 2 para obter uma descrição detalhada do erro.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Confira também

Aplica-se a

ConnectAsync(SocketType, ProtocolType, SocketAsyncEventArgs)

Inicia uma solicitação assíncrona para uma conexão com um host remoto.Begins an asynchronous request for a connection to a remote host.

public:
 static bool ConnectAsync(System::Net::Sockets::SocketType socketType, System::Net::Sockets::ProtocolType protocolType, System::Net::Sockets::SocketAsyncEventArgs ^ e);
public static bool ConnectAsync (System.Net.Sockets.SocketType socketType, System.Net.Sockets.ProtocolType protocolType, System.Net.Sockets.SocketAsyncEventArgs e);
static member ConnectAsync : System.Net.Sockets.SocketType * System.Net.Sockets.ProtocolType * System.Net.Sockets.SocketAsyncEventArgs -> bool
Public Shared Function ConnectAsync (socketType As SocketType, protocolType As ProtocolType, e As SocketAsyncEventArgs) As Boolean

Parâmetros

socketType
SocketType

Um dos valores de SocketType.One of the SocketType values.

protocolType
ProtocolType

Um dos valores de ProtocolType.One of the ProtocolType values.

e
SocketAsyncEventArgs

O objeto SocketAsyncEventArgs a ser usado nessa operação de soquete assíncrono.The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Retornos

Boolean

true se a operação de E/S está pendente.true if the I/O operation is pending. O evento Completed no parâmetro e será acionado após a conclusão da operação.The Completed event on the e parameter will be raised upon completion of the operation.

false se a operação de E/S foi concluída de forma síncrona.false if the I/O operation completed synchronously. Nesse caso, o evento Completed no parâmetro e não será gerado e o objeto e passado como um parâmetro poderá ser examinado imediatamente depois que a chamada do método for retornada para recuperar o resultado da operação.In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exceções

Um argumento não é válido.An argument is not valid. Essa exceção ocorrerá se vários buffers forem especificados e a propriedade BufferList não for nula.This exception occurs if multiple buffers are specified, the BufferList property is not null.

O parâmetro e e o RemoteEndPoint não podem ser nulos.The e parameter cannot be null and the RemoteEndPoint cannot be null.

O Socket está escutando ou uma operação de soquete já estava em andamento usando o objeto SocketAsyncEventArgs especificado no parâmetro e.The Socket is listening or a socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

Ocorreu um erro ao tentar acessar o soquete.An error occurred when attempting to access the socket.

É necessário o Windows XP ou posterior para esse método.Windows XP or later is required for this method. Essa exceção também ocorrerá se o ponto de extremidade local e o RemoteEndPoint não forem da mesma família de endereços.This exception also occurs if the local endpoint and the RemoteEndPoint are not the same address family.

O Socket foi fechado.The Socket has been closed.

Um chamador mais alto na pilha de chamadas não tem permissão para a operação solicitada.A caller higher in the call stack does not have permission for the requested operation.

Comentários

Se você estiver usando um protocolo orientado a conexão, o método M:System.Net.Sockets.Socket.ConnectAsync (System .net. Sockets. SocketType, System .net. Sockets. ProtocolType, System .net. Sockets. SocketAsyncEventArgs) iniciará uma solicitação assíncrona para uma conexão com o host remoto.If you are using a connection-oriented protocol, the M:System.Net.Sockets.Socket.ConnectAsync(System.Net.Sockets.SocketType,System.Net.Sockets.ProtocolType,System.Net.Sockets.SocketAsyncEventArgs) method starts an asynchronous request for a connection to the remote host. Se você estiver usando um protocolo sem conexão, ConnectAsync o estabelecerá um host remoto padrão especificado pelos socketType protocolType parâmetros e.If you are using a connectionless protocol, ConnectAsync establishes a default remote host specified by the socketType and protocolType parameters.

Para ser notificado da conclusão, você deve criar um método de retorno de chamada que implemente o <SocketAsyncEventArgs> delegado EventHandler e anexe o retorno de chamada ao SocketAsyncEventArgs.Completed evento.To be notified of completion, you must create a callback method that implements the EventHandler<SocketAsyncEventArgs> delegate and attach the callback to the SocketAsyncEventArgs.Completed event.

O chamador deve definir a SocketAsyncEventArgs.RemoteEndPoint propriedade como o IPEndPoint do host remoto ao qual se conectar.The caller must set the SocketAsyncEventArgs.RemoteEndPoint property to the IPEndPoint of the remote host to connect to.

O chamador pode definir a SocketAsyncEventArgs.UserToken propriedade para qualquer objeto de estado de usuário desejado antes de chamar o ConnectAsync método, de modo que as informações serão recuperáveis no método de retorno de chamada.The caller may set the SocketAsyncEventArgs.UserToken property to any user state object desired before calling the ConnectAsync method, so that the information will be retrievable in the callback method. Se o retorno de chamada precisar de mais informações do que um único objeto, uma classe pequena poderá ser criada para manter as outras informações de estado necessárias como membros.If the callback needs more information than a single object, a small class can be created to hold the other required state information as members.

Se você estiver usando um protocolo sem conexão, como o UDP, não precisará chamar ConnectAsync antes de enviar e receber dados.If you are using a connectionless protocol such as UDP, you do not have to call ConnectAsync before sending and receiving data. Você pode usar SendToAsync ReceiveFromAsync o e o para se comunicar com um host remoto.You can use SendToAsync and ReceiveFromAsync to communicate with a remote host. Se você chamar ConnectAsync , todos os datagramas que chegam de um endereço diferente do padrão especificado serão descartados.If you do call ConnectAsync, any datagrams that arrive from an address other than the specified default will be discarded. Se você quiser alterar o host remoto padrão, chame o ConnectAsync método novamente com o ponto de extremidade desejado.If you want to change the default remote host, call the ConnectAsync method again with the desired endpoint.

Se você quiser definir o host remoto padrão para um endereço de difusão, primeiro você deve chamar SetSocketOption e definir Broadcast para true .If you wish to set the default remote host to a broadcast address, you must first call SetSocketOption and set Broadcast to true. Se isso não for feito, o ConnectAsync método gerará um SocketException .If this is not done, the ConnectAsync method will throw a SocketException.

As seguintes propriedades e eventos no System.Net.Sockets.SocketAsyncEventArgs objeto são necessários:The following properties and events on the System.Net.Sockets.SocketAsyncEventArgs object are required:

Opcionalmente, pode ser fornecido um buffer que será enviado atomicamente no soquete depois que o ConnectAsync método for executado com sucesso.Optionally, a buffer may be provided which will atomically be sent on the socket after the ConnectAsync method succeeds. Nesse caso, a SocketAsyncEventArgs.Buffer propriedade precisa ser definida como o buffer que contém os dados a serem enviados e a SocketAsyncEventArgs.Count propriedade precisa ser definida como o número de bytes de dados a serem enviados do buffer.In this case, the SocketAsyncEventArgs.Buffer property needs to be set to the buffer containing the data to send and the SocketAsyncEventArgs.Count property needs to be set to the number of bytes of data to send from the buffer. Depois que uma conexão é estabelecida, esse buffer de dados é enviado.Once a connection is established, this buffer of data is sent.

Se você estiver usando um protocolo orientado a conexão e não chamar Bind antes ConnectAsync de chamar, o provedor de serviços subjacente atribuirá o número da porta e o endereço de rede local mais apropriado.If you are using a connection-oriented protocol and do not call Bind before calling ConnectAsync, the underlying service provider will assign the most appropriate local network address and port number.

Se você estiver usando um protocolo sem conexão, o provedor de serviços não atribuirá um endereço IP de rede local e um número de porta até que você chame os SendAsync ReceiveAsync métodos ou.If you are using a connectionless protocol, the service provider will not assign a local network IP address and port number until you call the SendAsync or ReceiveAsync methods.

O ConnectAsync método gera NotSupportedException se a família de endereços do Socket e o SocketAsyncEventArgs.RemoteEndPoint não são da mesma família de endereços.The ConnectAsync method throws NotSupportedException if the address family of the Socket and the SocketAsyncEventArgs.RemoteEndPoint are not the same address family.

Observação

Se você receber um SocketException ao chamar esse método, use a SocketException.ErrorCode propriedade para obter o código de erro específico.If you receive a SocketException when calling this method, use the SocketException.ErrorCode property to obtain the specific error code. Depois de obter esse código, consulte a documentação do código de erro da API do Windows Sockets versão 2 para obter uma descrição detalhada do erro.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Aplica-se a