## Uses of Interface
io.vertx.core.net.SocketAddress

- Packages that use SocketAddress
  Package | Description
  --- | ---
  io.vertx.core.datagram |
  io.vertx.core.http |
  io.vertx.core.net |
  io.vertx.core.spi.metrics |
  io.vertx.core.spi.observability |
  io.vertx.core.spi.transport |
  io.vertx.ext.web.client |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.grpc.client |
  io.vertx.httpproxy |
  io.vertx.mqtt |
  io.vertx.mysqlclient |
  io.vertx.pgclient |
  io.vertx.reactivex.core.net |
  io.vertx.rxjava.core.net |
  io.vertx.rxjava3.core.net |
  io.vertx.sqlclient |
  io.vertx.uring |

- - ### Uses of SocketAddress in io.vertx.core.datagram

    Methods in io.vertx.core.datagram that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | DatagramSocket.`localAddress()` Return the `SocketAddress` to which this `DatagramSocket` is bound.
    `SocketAddress` | DatagramPacket.`sender()` Returns the `SocketAddress` of the sender that sent this `DatagramPacket`.

  - ### Uses of SocketAddress in io.vertx.core.http

    Fields in io.vertx.core.http declared as SocketAddress
    Modifier and Type | Field and Description
    --- | ---
    `static SocketAddress` | RequestOptions.`DEFAULT_SERVER` The default value for server method = `null`

    Methods in io.vertx.core.http that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | RequestOptions.`getServer()` Get the server address to be used by the client request.
    `SocketAddress` | HttpConnection.`localAddress()`
    `default SocketAddress` | HttpServerRequest.`localAddress()`
    `SocketAddress` | WebSocketBase.`localAddress()`
    `SocketAddress` | HttpConnection.`localAddress(boolean real)` Like `HttpConnection.localAddress()` ()} but returns the server local address when `real` is `true`
    `SocketAddress` | HttpConnection.`remoteAddress()`
    `default SocketAddress` | HttpServerRequest.`remoteAddress()`
    `SocketAddress` | WebSocketBase.`remoteAddress()`
    `SocketAddress` | HttpConnection.`remoteAddress(boolean real)` Like `HttpConnection.remoteAddress()` but returns the proxy remote address when `real` is `true`

    Methods in io.vertx.core.http with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `Future<HttpServer>` | HttpServer.`listen(SocketAddress address)` Like `HttpServer.listen(SocketAddress, Handler)` but returns a `Future` of the asynchronous result
    `default HttpServer` | HttpServer.`listen(SocketAddress address, Handler<AsyncResult<HttpServer>> listenHandler)` Tell the server to start listening on the given address supplying a handler that will be called when the server is actually listening (or has failed).
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setServer(SocketAddress server)`
    `RequestOptions` | RequestOptions.`setServer(SocketAddress server)` Set the server address to be used by the client request.

  - ### Uses of SocketAddress in io.vertx.core.net

    Methods in io.vertx.core.net that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `static SocketAddress` | SocketAddress.`domainSocketAddress(String path)` Create a domain socket address from a `path`.
    `static SocketAddress` | SocketAddress.`inetSocketAddress(InetSocketAddress address)` Create a inet socket address from a Java `InetSocketAddress`.
    `static SocketAddress` | SocketAddress.`inetSocketAddress(int port, String host)` Create an inet socket address, `host` must be non `null` and `port` must be between `0` and `65536`.
    `SocketAddress` | NetSocket.`localAddress()`
    `SocketAddress` | NetSocket.`localAddress(boolean real)` Like `NetSocket.localAddress()` ()} but returns the server local address when `real` is `true`
    `SocketAddress` | NetSocket.`remoteAddress()`
    `SocketAddress` | NetSocket.`remoteAddress(boolean real)` Like `NetSocket.remoteAddress()` but returns the proxy remote address when `real` is `true`
    `static SocketAddress` | SocketAddress.`sharedRandomPort(int id, String host)` Create an inet socket address that binds to a shared random port identified by `id`.

    Methods in io.vertx.core.net with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `Future<NetSocket>` | NetClient.`connect(SocketAddress remoteAddress)` Like `NetClient.connect(SocketAddress, Handler)` but returns a `Future` of the asynchronous result
    `NetClient` | NetClient.`connect(SocketAddress remoteAddress, Handler<AsyncResult<NetSocket>> connectHandler)` Open a connection to a server at the specific `remoteAddress`.
    `Future<NetSocket>` | NetClient.`connect(SocketAddress remoteAddress, String serverName)` Like `NetClient.connect(SocketAddress, String, Handler)` but returns a `Future` of the asynchronous result
    `NetClient` | NetClient.`connect(SocketAddress remoteAddress, String serverName, Handler<AsyncResult<NetSocket>> connectHandler)` Open a connection to a server at the specific `remoteAddress`.
    `Future<NetServer>` | NetServer.`listen(SocketAddress localAddress)` Start listening on the specified local address, ignoring port and host configured in the `NetServerOptions` used when creating the server.
    `default NetServer` | NetServer.`listen(SocketAddress localAddress, Handler<AsyncResult<NetServer>> listenHandler)` Like `NetServer.listen(SocketAddress)` but providing a handler that will be notified when the server is listening, or fails.

  - ### Uses of SocketAddress in io.vertx.core.spi.metrics

    Methods in io.vertx.core.spi.metrics with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default void` | NetworkMetrics.`bytesRead(S socketMetric, SocketAddress remoteAddress, long numberOfBytes)` Called when bytes have been read
    `default void` | NetworkMetrics.`bytesWritten(S socketMetric, SocketAddress remoteAddress, long numberOfBytes)` Called when bytes have been written
    `default S` | TCPMetrics.`connected(SocketAddress remoteAddress, String remoteName)` Called when a client has connected, which is applicable for TCP connections. The remote name of the client is a best effort to provide the name of the remote host, i.e if the name is specified at creation time, this name will be used otherwise it will be the remote address.
    `default ClientMetrics<?,?,?,?>` | VertxMetrics.`createClientMetrics(SocketAddress remoteAddress, String type, String namespace)` Provides the client metrics SPI when a client has been created.
    `default ClientMetrics<R,T,HttpRequest,HttpResponse>` | HttpClientMetrics.`createEndpointMetrics(SocketAddress remoteAddress, int maxPoolSize)` Provides metrics for a particular endpoint
    `default HttpServerMetrics<?,?,?>` | VertxMetrics.`createHttpServerMetrics(HttpServerOptions options, SocketAddress localAddress)` Provides the http server metrics SPI when an http server is created.
    `default TCPMetrics<?>` | VertxMetrics.`createNetServerMetrics(NetServerOptions options, SocketAddress localAddress)` Provides the net server metrics SPI when a net server is created.
    `default void` | TCPMetrics.`disconnected(S socketMetric, SocketAddress remoteAddress)` Called when a client has disconnected, which is applicable for TCP connections.
    `default void` | NetworkMetrics.`exceptionOccurred(S socketMetric, SocketAddress remoteAddress, Throwable t)` Called when exceptions occur for a specific connection.
    `default void` | DatagramSocketMetrics.`listening(String localName, SocketAddress localAddress)` Called when a socket is listening.

  - ### Uses of SocketAddress in io.vertx.core.spi.observability

    Methods in io.vertx.core.spi.observability that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | HttpRequest.`remoteAddress()`

  - ### Uses of SocketAddress in io.vertx.core.spi.transport

    Methods in io.vertx.core.spi.transport that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default SocketAddress` | Transport.`convert(SocketAddress address)`

    Methods in io.vertx.core.spi.transport with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default SocketAddress` | Transport.`convert(SocketAddress address)`

  - ### Uses of SocketAddress in io.vertx.ext.web.client

    Methods in io.vertx.ext.web.client with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, int port, String host, String requestURI)` Like `WebClient.request(HttpMethod, int, String, String)` using the `serverAddress` parameter to connect to the server instead of the `port` and `host` parameters.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, int port, String host, UriTemplate requestURI)` Like `WebClient.request(HttpMethod, int, String, UriTemplate)` using the `serverAddress` parameter to connect to the server instead of the `port` and `host` parameters.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, RequestOptions options)` Like `WebClient.request(HttpMethod, RequestOptions)` using the `serverAddress` parameter to connect to the server instead of the `options` parameter.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, String requestURI)` Like `WebClient.request(HttpMethod, String)` using the `serverAddress` parameter to connect to the server instead of the default port and default host.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, String host, String requestURI)` Like `WebClient.request(HttpMethod, String, String)` using the `serverAddress` parameter to connect to the server instead of the default port and `host` parameter.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, String host, UriTemplate requestURI)` Like `WebClient.request(HttpMethod, String, UriTemplate)` using the `serverAddress` parameter to connect to the server instead of the default port and `host` parameter.
    `HttpRequest<Buffer>` | WebClient.`request(HttpMethod method, SocketAddress serverAddress, UriTemplate requestURI)` Like `WebClient.request(HttpMethod, UriTemplate)` using the `serverAddress` parameter to connect to the server instead of the default port and default host.
    `HttpRequest<Buffer>` | WebClient.`requestAbs(HttpMethod method, SocketAddress serverAddress, String absoluteURI)` Like `WebClient.requestAbs(HttpMethod, String)` using the `serverAddress` parameter to connect to the server instead of the `absoluteURI` parameter.
    `HttpRequest<Buffer>` | WebClient.`requestAbs(HttpMethod method, SocketAddress serverAddress, UriTemplate absoluteURI)` Like `WebClient.requestAbs(HttpMethod, UriTemplate)` using the `serverAddress` parameter to connect to the server instead of the `absoluteURI` parameter.

  - ### Uses of SocketAddress in io.vertx.ext.web.handler.sockjs

    Methods in io.vertx.ext.web.handler.sockjs that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | SockJSSocket.`localAddress()` Return the local address for this socket
    `SocketAddress` | SockJSSocket.`remoteAddress()` Return the remote address for this socket

  - ### Uses of SocketAddress in io.vertx.grpc.client

    Methods in io.vertx.grpc.client with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default <Req,Resp,T> Future<T>` | GrpcClient.`call(SocketAddress server, io.grpc.MethodDescriptor<Req,Resp> service, Handler<GrpcClientRequest<Req,Resp>> requestHandler, java.util.function.Function<GrpcClientResponse<Req,Resp>,Future<T>> resultFn)` Call the `service` gRPC service hosted by `server`.
    `Future<GrpcClientRequest<Buffer,Buffer>>` | GrpcClient.`request(SocketAddress server)` Connect to the remote `server` and create a request for any hosted gRPC service.
    `<Req,Resp> Future<GrpcClientRequest<Req,Resp>>` | GrpcClient.`request(SocketAddress server, io.grpc.MethodDescriptor<Req,Resp> service)` Connect to the remote `server` and create a request for given `method` of a hosted gRPC service.

    Constructors in io.vertx.grpc.client with parameters of type SocketAddress
    Constructor and Description
    `GrpcClientChannel(GrpcClient client, SocketAddress server)`

  - ### Uses of SocketAddress in io.vertx.httpproxy

    Methods in io.vertx.httpproxy with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default HttpProxy` | HttpProxy.`origin(SocketAddress address)` Set the `SocketAddress` of the origin.

    Method parameters in io.vertx.httpproxy with type arguments of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `default HttpProxy` | HttpProxy.`originSelector(java.util.function.Function<HttpServerRequest,Future<SocketAddress>> selector)` Set a selector that resolves the origin address based on the incoming HTTP request.

  - ### Uses of SocketAddress in io.vertx.mqtt

    Methods in io.vertx.mqtt that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | MqttEndpoint.`localAddress()`
    `SocketAddress` | MqttEndpoint.`remoteAddress()`

  - ### Uses of SocketAddress in io.vertx.mysqlclient

    Methods in io.vertx.mysqlclient that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | MySQLConnectOptions.`getSocketAddress()`

  - ### Uses of SocketAddress in io.vertx.pgclient

    Methods in io.vertx.pgclient that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | PgConnectOptions.`getSocketAddress()`

  - ### Uses of SocketAddress in io.vertx.reactivex.core.net

    Methods in io.vertx.reactivex.core.net that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | SocketAddress.`getDelegate()`

    Methods in io.vertx.reactivex.core.net with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `static SocketAddress` | SocketAddress.`newInstance(SocketAddress arg)`

    Constructors in io.vertx.reactivex.core.net with parameters of type SocketAddress
    Constructor and Description
    `SocketAddress(SocketAddress delegate)`

  - ### Uses of SocketAddress in io.vertx.rxjava.core.net

    Methods in io.vertx.rxjava.core.net that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | SocketAddress.`getDelegate()`

    Methods in io.vertx.rxjava.core.net with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `static SocketAddress` | SocketAddress.`newInstance(SocketAddress arg)`

    Constructors in io.vertx.rxjava.core.net with parameters of type SocketAddress
    Constructor and Description
    `SocketAddress(SocketAddress delegate)`

  - ### Uses of SocketAddress in io.vertx.rxjava3.core.net

    Methods in io.vertx.rxjava3.core.net that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | SocketAddress.`getDelegate()`

    Methods in io.vertx.rxjava3.core.net with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `static SocketAddress` | SocketAddress.`newInstance(SocketAddress arg)`

    Constructors in io.vertx.rxjava3.core.net with parameters of type SocketAddress
    Constructor and Description
    `SocketAddress(SocketAddress delegate)`

  - ### Uses of SocketAddress in io.vertx.sqlclient

    Methods in io.vertx.sqlclient that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | SqlConnectOptions.`getSocketAddress()`

  - ### Uses of SocketAddress in io.vertx.uring

    Methods in io.vertx.uring that return SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | IOUringTransport.`convert(SocketAddress address)`

    Methods in io.vertx.uring with parameters of type SocketAddress
    Modifier and Type | Method and Description
    --- | ---
    `SocketAddress` | IOUringTransport.`convert(SocketAddress address)`

Copyright © 2024 Eclipse. All rights reserved.