Package org.microproxy.udp

Interface UdpContext

public interface UdpContext
One UDP flow, as a UdpInterceptor sees it: where it goes, and a way to add datagrams. The same context is given to every hook call of the flow, so it can serve as a key for per-flow state.

  • Method Summary

    Modifier and Type
    Method
    Description
    InetSocketAddress
    clientAddress()
    The client's address.
    long
    connectionId()
    The client connection the flow belongs to (FlowContext.getConnectionId()).
    FlowContext
    flowContext()
    The exchange that opened the flow (its CONNECT-UDP request, on its own HTTP/3 stream).
    String
    host()
    The host the flow goes to, as the CONNECT-UDP request named it.
    int
    port()
    The port the flow goes to.
    void
    send(boolean fromClient, byte[] data)
    Sends a datagram as if one side had sent it: with fromClient it goes to the target, else to the client.
    InetSocketAddress
    targetAddress()
    The address the flow's socket is connected to: the target, resolved.

  • Method Details

    • connectionId

      long connectionId()
      The client connection the flow belongs to (FlowContext.getConnectionId()).
      Returns:
      the client connection's id

    • clientAddress

      InetSocketAddress clientAddress()
      The client's address.
      Returns:
      the client address

    • host

      String host()
      The host the flow goes to, as the CONNECT-UDP request named it.
      Returns:
      the target host name or IP address (IPv6 without brackets)

    • port

      int port()
      The port the flow goes to.
      Returns:
      the target port

    • targetAddress

      InetSocketAddress targetAddress()
      The address the flow's socket is connected to: the target, resolved.
      Returns:
      the target's address

    • flowContext

      FlowContext flowContext()
      The exchange that opened the flow (its CONNECT-UDP request, on its own HTTP/3 stream).
      Returns:
      the flow context

    • send

      void send(boolean fromClient, byte[] data)
      Sends a datagram as if one side had sent it: with fromClient it goes to the target, else to the client. It does not pass through UdpInterceptor.udpMessage(org.microproxy.udp.UdpMessage, org.microproxy.udp.UdpContext), and is queued as relayed datagrams are, so it may be dropped as they may.
      Parameters:
      fromClient - true to send to the target, false to send to the client
      data - the payload of one datagram
      Throws:
      IllegalStateException - if the flow has ended
      NullPointerException - if data is null