Package io.quarkus.websockets.next.runtime.spi.telemetry

Record Class WebSocketEndpointContext

java.lang.Object
java.lang.Record
io.quarkus.websockets.next.runtime.spi.telemetry.WebSocketEndpointContext
Record Components:
route - endpoint route
endpointKind - endpoint kind (either client endpoint or server endpoint)
connectionContextStorage - context data recorded when the WebSocket connection opened
connectionId - the WebSocket connection id
targetId - for a server endpoint, this is an endpoint id, while for a client endpoint, this is a client id
public record WebSocketEndpointContext(String route, EndpointKind endpointKind, Map<String,Object> connectionContextStorage, String connectionId, String targetId) extends Record
A WebSocket endpoint contextual data needed when collecting WebSockets metrics and traces.

  • Constructor Details

    • WebSocketEndpointContext

      public WebSocketEndpointContext(String route, EndpointKind endpointKind, Map<String,Object> connectionContextStorage, String connectionId, String targetId)
      Creates an instance of a WebSocketEndpointContext record class.
      Parameters:
      route - the value for the route record component
      endpointKind - the value for the endpointKind record component
      connectionContextStorage - the value for the connectionContextStorage record component
      connectionId - the value for the connectionId record component
      targetId - the value for the targetId record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • route

      public String route()
      Returns the value of the route record component.
      Returns:
      the value of the route record component

    • endpointKind

      public EndpointKind endpointKind()
      Returns the value of the endpointKind record component.
      Returns:
      the value of the endpointKind record component

    • connectionContextStorage

      public Map<String,Object> connectionContextStorage()
      Returns the value of the connectionContextStorage record component.
      Returns:
      the value of the connectionContextStorage record component

    • connectionId

      public String connectionId()
      Returns the value of the connectionId record component.
      Returns:
      the value of the connectionId record component

    • targetId

      public String targetId()
      Returns the value of the targetId record component.
      Returns:
      the value of the targetId record component