io.vertx.rxjava3.core.datagram

## Class DatagramSocket

- java.lang.Object
- - io.vertx.rxjava3.core.datagram.DatagramSocket

- All Implemented Interfaces:
    Measured, ReadStream<DatagramPacket>, StreamBase

      public class DatagramSocket
      extends Object
      implements ReadStream<DatagramPacket>, Measured

  A datagram socket can be used to send `DatagramPacket`'s to remote datagram servers and receive `DatagramPacket`s .

  Usually you use a datagram socket to send UDP over the wire. UDP is connection-less which means you are not connected to the remote peer in a persistent way. Because of this you have to supply the address and port of the remote peer when sending data.

  You can send data to ipv4 or ipv6 addresses, which also include multicast addresses.

  Please consult the documentation for more information on datagram sockets.

  NOTE: This class has been automatically generated from the `original` non RX-ified interface using Vert.x codegen.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<DatagramSocket>` | `__TYPE_ARG`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `DatagramSocket(DatagramSocket delegate)`
    `DatagramSocket(Object delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `Completable` | `blockMulticastGroup(String multicastAddress, String sourceToBlock)` Block the given address for the given multicast address and notifies the once the operation completes.
    `Completable` | `blockMulticastGroup(String multicastAddress, String networkInterface, String sourceToBlock)` Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.
    `Completable` | `close()` Closes the `DatagramSocket` implementation asynchronous and notifies the handler once done.
    `DatagramSocket` | `endHandler(Handler<Void> endHandler)` Deprecated.
    `boolean` | `equals(Object o)`
    `DatagramSocket` | `exceptionHandler(Handler<Throwable> handler)` Set an exception handler on the read stream.
    `DatagramSocket` | `fetch(long amount)` Deprecated.
    `DatagramSocket` | `getDelegate()`
    `DatagramSocket` | `handler(Handler<DatagramPacket> handler)` Set a data handler.
    `int` | `hashCode()`
    `boolean` | `isMetricsEnabled()` Whether the metrics are enabled for this measured object
    `Single<DatagramSocket>` | `listen(int port, String host)` Start listening on the given port and host.
    `Completable` | `listenMulticastGroup(String multicastAddress)` Joins a multicast group and listens for packets send to it.
    `Completable` | `listenMulticastGroup(String multicastAddress, String networkInterface, String source)` Joins a multicast group and listens for packets send to it on the given network interface.
    `SocketAddress` | `localAddress()` Return the `SocketAddress` to which this `DatagramSocket` is bound.
    `static DatagramSocket` | `newInstance(DatagramSocket arg)`
    `DatagramSocket` | `pause()` Deprecated.
    `Pipe<DatagramPacket>` | `pipe()` Pause this stream and return a to transfer the elements of this stream to a destination .
    `Completable` | `pipeTo(WriteStream<DatagramPacket> dst)` Pipe this `ReadStream` to the `WriteStream`.
    `DatagramSocket` | `resume()` Deprecated.
    `Completable` | `rxBlockMulticastGroup(String multicastAddress, String sourceToBlock)` Block the given address for the given multicast address and notifies the once the operation completes.
    `Completable` | `rxBlockMulticastGroup(String multicastAddress, String networkInterface, String sourceToBlock)` Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.
    `Completable` | `rxClose()` Closes the `DatagramSocket` implementation asynchronous and notifies the handler once done.
    `Single<DatagramSocket>` | `rxListen(int port, String host)` Start listening on the given port and host.
    `Completable` | `rxListenMulticastGroup(String multicastAddress)` Joins a multicast group and listens for packets send to it.
    `Completable` | `rxListenMulticastGroup(String multicastAddress, String networkInterface, String source)` Joins a multicast group and listens for packets send to it on the given network interface.
    `Completable` | `rxPipeTo(WriteStream<DatagramPacket> dst)` Pipe this `ReadStream` to the `WriteStream`.
    `Completable` | `rxSend(Buffer packet, int port, String host)` Write the given `Buffer` to the `SocketAddress`.
    `Completable` | `rxSend(String str, int port, String host)` Write the given `String` to the `SocketAddress` using UTF8 encoding.
    `Completable` | `rxSend(String str, String enc, int port, String host)` Write the given `String` to the `SocketAddress` using the given encoding.
    `Completable` | `rxUnlistenMulticastGroup(String multicastAddress)` Leaves a multicast group and stops listening for packets send to it.
    `Completable` | `rxUnlistenMulticastGroup(String multicastAddress, String networkInterface, String source)` Leaves a multicast group and stops listening for packets send to it on the given network interface.
    `Completable` | `send(Buffer packet, int port, String host)` Write the given `Buffer` to the `SocketAddress`.
    `Completable` | `send(String str, int port, String host)` Write the given `String` to the `SocketAddress` using UTF8 encoding.
    `Completable` | `send(String str, String enc, int port, String host)` Write the given `String` to the `SocketAddress` using the given encoding.
    `WriteStream<Buffer>` | `sender(int port, String host)` Returns a `WriteStream` able to send to the `SocketAddress`.
    `Flowable<DatagramPacket>` | `toFlowable()`
    `Observable<DatagramPacket>` | `toObservable()`
    `String` | `toString()`
    `Completable` | `unlistenMulticastGroup(String multicastAddress)` Leaves a multicast group and stops listening for packets send to it.
    `Completable` | `unlistenMulticastGroup(String multicastAddress, String networkInterface, String source)` Leaves a multicast group and stops listening for packets send to it on the given network interface.

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface io.vertx.rxjava3.core.streams.ReadStream

      `newInstance, newInstance`

    - ### Methods inherited from interface io.vertx.rxjava3.core.streams.StreamBase

      `newInstance`

    - ### Methods inherited from interface io.vertx.rxjava3.core.metrics.Measured

      `newInstance`

- - ### Field Detail

    - #### __TYPE_ARG

          public static final io.vertx.lang.rx.TypeArg<DatagramSocket> __TYPE_ARG

  - ### Constructor Detail

    - #### DatagramSocket

          public DatagramSocket(DatagramSocket delegate)

    - #### DatagramSocket

          public DatagramSocket(Object delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### getDelegate

          public DatagramSocket getDelegate()

      Specified by:
        `getDelegate` in interface `Measured`
      Specified by:
        `getDelegate` in interface `ReadStream<DatagramPacket>`
      Specified by:
        `getDelegate` in interface `StreamBase`

    - #### toObservable

          public Observable<DatagramPacket> toObservable()

      Specified by:
        `toObservable` in interface `ReadStream<DatagramPacket>`

    - #### toFlowable

          public Flowable<DatagramPacket> toFlowable()

      Specified by:
        `toFlowable` in interface `ReadStream<DatagramPacket>`

    - #### isMetricsEnabled

          public boolean isMetricsEnabled()

      Whether the metrics are enabled for this measured object
      Specified by:
        `isMetricsEnabled` in interface `Measured`
      Returns:
        `true` if metrics are enabled

    - #### pipe

          public Pipe<DatagramPacket> pipe()

      Pause this stream and return a to transfer the elements of this stream to a destination .

      The stream will be resumed when the pipe will be wired to a `WriteStream`.
      Specified by:
        `pipe` in interface `ReadStream<DatagramPacket>`
      Returns:
        a pipe

    - #### pipeTo

          public Completable pipeTo(WriteStream<DatagramPacket> dst)

      Pipe this `ReadStream` to the `WriteStream`.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result.

      Specified by:
        `pipeTo` in interface `ReadStream<DatagramPacket>`
      Parameters:
        `dst` - the destination write stream
      Returns:

    - #### rxPipeTo

          public Completable rxPipeTo(WriteStream<DatagramPacket> dst)

      Pipe this `ReadStream` to the `WriteStream`.

      Elements emitted by this stream will be written to the write stream until this stream ends or fails.

      Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result.

      Specified by:
        `rxPipeTo` in interface `ReadStream<DatagramPacket>`
      Parameters:
        `dst` - the destination write stream
      Returns:

    - #### send

          public Completable send(Buffer packet,
                                  int port,
                                  String host)

      Write the given `Buffer` to the `SocketAddress`. The `Handler` will be notified once the write completes.
      Parameters:
        `packet` - the `Buffer` to write
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxSend

          public Completable rxSend(Buffer packet,
                                    int port,
                                    String host)

      Write the given `Buffer` to the `SocketAddress`. The `Handler` will be notified once the write completes.
      Parameters:
        `packet` - the `Buffer` to write
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### sender

          public WriteStream<Buffer> sender(int port,
                                            String host)

      Returns a `WriteStream` able to send to the `SocketAddress`.
      Parameters:
        `port` - the port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        the write stream for sending packets

    - #### send

          public Completable send(String str,
                                  int port,
                                  String host)

      Write the given `String` to the `SocketAddress` using UTF8 encoding. The will be notified once the write completes.
      Parameters:
        `str` - the `String` to write
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxSend

          public Completable rxSend(String str,
                                    int port,
                                    String host)

      Write the given `String` to the `SocketAddress` using UTF8 encoding. The will be notified once the write completes.
      Parameters:
        `str` - the `String` to write
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### send

          public Completable send(String str,
                                  String enc,
                                  int port,
                                  String host)

      Write the given `String` to the `SocketAddress` using the given encoding. The will be notified once the write completes.
      Parameters:
        `str` - the `String` to write
        `enc` - the charset used for encoding
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxSend

          public Completable rxSend(String str,
                                    String enc,
                                    int port,
                                    String host)

      Write the given `String` to the `SocketAddress` using the given encoding. The will be notified once the write completes.
      Parameters:
        `str` - the `String` to write
        `enc` - the charset used for encoding
        `port` - the host port of the remote peer
        `host` - the host address of the remote peer
      Returns:
        a reference to this, so the API can be used fluently

    - #### close

          public Completable close()

      Closes the `DatagramSocket` implementation asynchronous and notifies the handler once done.
      Returns:

    - #### rxClose

          public Completable rxClose()

      Closes the `DatagramSocket` implementation asynchronous and notifies the handler once done.
      Returns:

    - #### localAddress

          public SocketAddress localAddress()

      Return the `SocketAddress` to which this `DatagramSocket` is bound.
      Returns:
        the socket address

    - #### listenMulticastGroup

          public Completable listenMulticastGroup(String multicastAddress)

      Joins a multicast group and listens for packets send to it. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxListenMulticastGroup

          public Completable rxListenMulticastGroup(String multicastAddress)

      Joins a multicast group and listens for packets send to it. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
      Returns:
        a reference to this, so the API can be used fluently

    - #### listenMulticastGroup

          public Completable listenMulticastGroup(String multicastAddress,
                                                  String networkInterface,
                                                  String source)

      Joins a multicast group and listens for packets send to it on the given network interface. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
        `networkInterface` - the network interface on which to listen for packets.
        `source` - the address of the source for which we will listen for multicast packets
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxListenMulticastGroup

          public Completable rxListenMulticastGroup(String multicastAddress,
                                                    String networkInterface,
                                                    String source)

      Joins a multicast group and listens for packets send to it on the given network interface. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
        `networkInterface` - the network interface on which to listen for packets.
        `source` - the address of the source for which we will listen for multicast packets
      Returns:
        a reference to this, so the API can be used fluently

    - #### unlistenMulticastGroup

          public Completable unlistenMulticastGroup(String multicastAddress)

      Leaves a multicast group and stops listening for packets send to it. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to leave
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxUnlistenMulticastGroup

          public Completable rxUnlistenMulticastGroup(String multicastAddress)

      Leaves a multicast group and stops listening for packets send to it. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to leave
      Returns:
        a reference to this, so the API can be used fluently

    - #### unlistenMulticastGroup

          public Completable unlistenMulticastGroup(String multicastAddress,
                                                    String networkInterface,
                                                    String source)

      Leaves a multicast group and stops listening for packets send to it on the given network interface. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
        `networkInterface` - the network interface on which to listen for packets.
        `source` - the address of the source for which we will listen for multicast packets
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxUnlistenMulticastGroup

          public Completable rxUnlistenMulticastGroup(String multicastAddress,
                                                      String networkInterface,
                                                      String source)

      Leaves a multicast group and stops listening for packets send to it on the given network interface. The is notified once the operation completes.
      Parameters:
        `multicastAddress` - the address of the multicast group to join
        `networkInterface` - the network interface on which to listen for packets.
        `source` - the address of the source for which we will listen for multicast packets
      Returns:
        a reference to this, so the API can be used fluently

    - #### blockMulticastGroup

          public Completable blockMulticastGroup(String multicastAddress,
                                                 String sourceToBlock)

      Block the given address for the given multicast address and notifies the once the operation completes.
      Parameters:
        `multicastAddress` - the address for which you want to block the source address
        `sourceToBlock` - the source address which should be blocked. You will not receive an multicast packets for it anymore.
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxBlockMulticastGroup

          public Completable rxBlockMulticastGroup(String multicastAddress,
                                                   String sourceToBlock)

      Block the given address for the given multicast address and notifies the once the operation completes.
      Parameters:
        `multicastAddress` - the address for which you want to block the source address
        `sourceToBlock` - the source address which should be blocked. You will not receive an multicast packets for it anymore.
      Returns:
        a reference to this, so the API can be used fluently

    - #### blockMulticastGroup

          public Completable blockMulticastGroup(String multicastAddress,
                                                 String networkInterface,
                                                 String sourceToBlock)

      Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.
      Parameters:
        `multicastAddress` - the address for which you want to block the source address
        `networkInterface` - the network interface on which the blocking should occur.
        `sourceToBlock` - the source address which should be blocked. You will not receive an multicast packets for it anymore.
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxBlockMulticastGroup

          public Completable rxBlockMulticastGroup(String multicastAddress,
                                                   String networkInterface,
                                                   String sourceToBlock)

      Block the given address for the given multicast address on the given network interface and notifies the once the operation completes.
      Parameters:
        `multicastAddress` - the address for which you want to block the source address
        `networkInterface` - the network interface on which the blocking should occur.
        `sourceToBlock` - the source address which should be blocked. You will not receive an multicast packets for it anymore.
      Returns:
        a reference to this, so the API can be used fluently

    - #### listen

          public Single<DatagramSocket> listen(int port,
                                               String host)

      Start listening on the given port and host. The handler will be called when the socket is listening.
      Parameters:
        `port` - the port to listen on
        `host` - the host to listen on
      Returns:
        a reference to this, so the API can be used fluently

    - #### rxListen

          public Single<DatagramSocket> rxListen(int port,
                                                 String host)

      Start listening on the given port and host. The handler will be called when the socket is listening.
      Parameters:
        `port` - the port to listen on
        `host` - the host to listen on
      Returns:
        a reference to this, so the API can be used fluently

    - #### pause

          @Deprecated
          public DatagramSocket pause()

      Deprecated.
      Description copied from interface: `ReadStream`
      Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.

      While it's paused, no data will be sent to the data `handler`.

      Specified by:
        `pause` in interface `ReadStream<DatagramPacket>`
      Returns:

    - #### resume

          @Deprecated
          public DatagramSocket resume()

      Deprecated.
      Description copied from interface: `ReadStream`
      Resume reading, and sets the buffer in `flowing` mode.

      If the `ReadStream` has been paused, reading will recommence on it.
      Specified by:
        `resume` in interface `ReadStream<DatagramPacket>`
      Returns:

    - #### fetch

          @Deprecated
          public DatagramSocket fetch(long amount)

      Deprecated.
      Description copied from interface: `ReadStream`
      Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand.
      Specified by:
        `fetch` in interface `ReadStream<DatagramPacket>`
      Parameters:
        `amount` -
      Returns:

    - #### endHandler

          @Deprecated
          public DatagramSocket endHandler(Handler<Void> endHandler)

      Deprecated.
      Description copied from interface: `ReadStream`
      Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
      Specified by:
        `endHandler` in interface `ReadStream<DatagramPacket>`
      Parameters:
        `endHandler` -
      Returns:

    - #### handler

          public DatagramSocket handler(Handler<DatagramPacket> handler)

      Description copied from interface: `ReadStream`
      Set a data handler. As data is read, the handler will be called with the data.
      Specified by:
        `handler` in interface `ReadStream<DatagramPacket>`
      Returns:
        a reference to this, so the API can be used fluently

    - #### exceptionHandler

          public DatagramSocket exceptionHandler(Handler<Throwable> handler)

      Description copied from interface: `ReadStream`
      Set an exception handler on the read stream.
      Specified by:
        `exceptionHandler` in interface `ReadStream<DatagramPacket>`
      Specified by:
        `exceptionHandler` in interface `StreamBase`
      Parameters:
        `handler` - the exception handler
      Returns:
        a reference to this, so the API can be used fluently

    - #### newInstance

          public static DatagramSocket newInstance(DatagramSocket arg)

Copyright © 2023 Eclipse. All rights reserved.