Compartir a través de

WebPubSubServiceClient.CloseConnectionAsync Método

  • Referencia

Definición

Espacio de nombres:
Azure.Messaging.WebPubSub
Ensamblado:
Azure.Messaging.WebPubSub.dll
Paquete:
Azure.Messaging.WebPubSub v1.3.0
Source:
WebPubSubServiceClient.cs

Cierre la conexión de cliente.

public virtual System.Threading.Tasks.Task<Azure.Response> CloseConnectionAsync (string connectionId, string reason = default, Azure.RequestContext context = default);
abstract member CloseConnectionAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CloseConnectionAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CloseConnectionAsync (connectionId As String, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parámetros

connectionId
String

Id. de conexión de destino.

reason
String

Motivo por el que se cierra la conexión de cliente.

context
RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

Task<Response>

Respuesta devuelta desde el servicio.

Excepciones

ArgumentNullException

connectionId es null.

ArgumentException

connectionId es una cadena vacía y se espera que no esté vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a CloseConnectionAsync con los parámetros necesarios.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseConnectionAsync("<connectionId>");
Console.WriteLine(response.Status);

En este ejemplo se muestra cómo llamar a CloseConnectionAsync con todos los parámetros.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseConnectionAsync("<connectionId>", "<reason>");
Console.WriteLine(response.Status);

Comentarios

Esquema para Response Error:

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }

Se aplica a