类 HandshakeInfo

构造器详细资料

• HandshakeInfo

  public HandshakeInfo​(URI uri,
                       HttpHeaders headers,
                       reactor.core.publisher.Mono<Principal> principal,
                       @Nullable
                       String protocol)

  Constructor with basic information about the handshake.

  参数:

  uri - the endpoint URL

  headers - request headers for server or response headers or client

  principal - the principal for the session

  protocol - the negotiated sub-protocol (may be null)

• HandshakeInfo

  public HandshakeInfo​(URI uri,
                       HttpHeaders headers,
                       reactor.core.publisher.Mono<Principal> principal,
                       @Nullable
                       String protocol,
                       @Nullable
                       InetSocketAddress remoteAddress,
                       Map<String,​Object> attributes,
                       @Nullable
                       String logPrefix)

  Constructor targetting server-side use with extra information about the handshake, the remote address, and a pre-existing log prefix for correlation.

  参数:

  uri - the endpoint URL

  headers - request headers for server or response headers or client

  principal - the principal for the session

  protocol - the negotiated sub-protocol (may be null)

  remoteAddress - the remote address where the handshake came from

  attributes - initial attributes to use for the WebSocket session

  logPrefix - log prefix used during the handshake for correlating log messages, if any.

  从以下版本开始:

  5.1

方法详细资料

• getUri

  public URI getUri()

  Return the URL for the WebSocket endpoint.

• getHeaders

  public HttpHeaders getHeaders()

  Return the handshake HTTP headers. Those are the request headers for a server session and the response headers for a client session.

• getPrincipal

  public reactor.core.publisher.Mono<Principal> getPrincipal()

  Return the principal associated with the handshake HTTP request.

• getSubProtocol

  @Nullable
  public String getSubProtocol()

  The sub-protocol negotiated at handshake time, or null if none.

  另请参阅:

  https://tools.ietf.org/html/rfc6455#section-1.9

• getRemoteAddress

  @Nullable
  public InetSocketAddress getRemoteAddress()

  For a server-side session this is the remote address where the handshake request came from.

  从以下版本开始:

  5.1

• getAttributes

  public Map<String,​Object> getAttributes()

  Attributes extracted from the handshake request to be added to the WebSocket session.

  从以下版本开始:

  5.1

• getLogPrefix

  @Nullable
  public String getLogPrefix()

  A log prefix used in the handshake to correlate log messages, if any.

  返回:

  a log prefix, or null if not specified

  从以下版本开始:

  5.1

• toString

  public String toString()

  覆盖:

  toString 在类中 Object