io.vertx.rxjava.core.net.NetSocket Maven / Gradle / Ivy
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.vertx.rxjava.core.net;
import rx.Observable;
import rx.Single;
import io.vertx.rx.java.RxHelper;
import io.vertx.rx.java.WriteStreamSubscriber;
import io.vertx.rx.java.SingleOnSubscribeAdapter;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;
/**
 * Represents a socket-like interface to a TCP connection on either the
 * client or the server side.
 * 
 * Instances of this class are created on the client side by an {@link io.vertx.rxjava.core.net.NetClient}
 * when a connection to a server is made, or on the server side by a {@link io.vertx.rxjava.core.net.NetServer}
 * when a server accepts a connection.
 * 
 * It implements both  and  so it can be used with
 * {@link io.vertx.rxjava.core.streams.Pipe} to pipe data with flow control.
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.core.net.NetSocket original} non RX-ified interface using Vert.x codegen.
 */
@RxGen(io.vertx.core.net.NetSocket.class)
public class NetSocket implements io.vertx.rxjava.core.streams.ReadStream, io.vertx.rxjava.core.streams.WriteStream {
  @Override
  public String toString() {
    return delegate.toString();
  }
  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    NetSocket that = (NetSocket) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }
  public static final TypeArg __TYPE_ARG = new TypeArg<>(    obj -> new NetSocket((io.vertx.core.net.NetSocket) obj),
    NetSocket::getDelegate
  );
  private final io.vertx.core.net.NetSocket delegate;
  
  public NetSocket(io.vertx.core.net.NetSocket delegate) {
    this.delegate = delegate;
  }
  public NetSocket(Object delegate) {
    this.delegate = (io.vertx.core.net.NetSocket)delegate;
  }
  public io.vertx.core.net.NetSocket getDelegate() {
    return delegate;
  }
  private Observable observable;
  public synchronized Observable toObservable() {
    if (observable == null) {
      Function conv = io.vertx.rxjava.core.buffer.Buffer::newInstance;
      observable = RxHelper.toObservable(delegate, conv);
    }
    return observable;
  }
  private WriteStreamSubscriber subscriber;
  public synchronized WriteStreamSubscriber toSubscriber() {
    if (subscriber == null) {
      Function conv = io.vertx.rxjava.core.buffer.Buffer::getDelegate;
      subscriber = RxHelper.toSubscriber(getDelegate(), conv);
    }
    return subscriber;
  }
  private static final TypeArg TYPE_ARG_0 = new TypeArg(o1 -> io.vertx.rxjava.core.buffer.Buffer.newInstance((io.vertx.core.buffer.Buffer)o1), o1 -> o1.getDelegate());
  /**
   * Same as  but with an handler called when the operation completes
   * @param data 
   * @param handler 
   */
  public void end(io.vertx.rxjava.core.buffer.Buffer data, io.vertx.core.Handler> handler) { 
    delegate.end(data.getDelegate(), handler);
  }
  /**
   * Same as  but with an handler called when the operation completes
   * @param data 
   */
  public void end(io.vertx.rxjava.core.buffer.Buffer data) {
    end(data, ar -> { });
  }
    /**
   * Same as  but with an handler called when the operation completes
   * @param data 
   * @return 
   */
  public rx.Single rxEnd(io.vertx.rxjava.core.buffer.Buffer data) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      end(data, fut);
    }));
  }
  /**
   * This will return true if there are more bytes in the write queue than the value set using {@link io.vertx.rxjava.core.net.NetSocket#setWriteQueueMaxSize}
   * @return true if write queue is full
   */
  public boolean writeQueueFull() { 
    boolean ret = delegate.writeQueueFull();
    return ret;
  }
  /**
   * 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.
   * @return a pipe
   */
  public io.vertx.rxjava.core.streams.Pipe pipe() { 
    io.vertx.rxjava.core.streams.Pipe ret = io.vertx.rxjava.core.streams.Pipe.newInstance((io.vertx.core.streams.Pipe)delegate.pipe(), TYPE_ARG_0);
    return ret;
  }
  /**
   * 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.
   * @param dst the destination write stream
   * @param handler 
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst, io.vertx.core.Handler> handler) { 
    delegate.pipeTo(dst.getDelegate(), handler);
  }
  /**
   * 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.
   * @param dst the destination write stream
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst) {
    pipeTo(dst, ar -> { });
  }
    /**
   * 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.
   * @param dst the destination write stream
   * @return 
   */
  public rx.Single rxPipeTo(io.vertx.rxjava.core.streams.WriteStream dst) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      pipeTo(dst, fut);
    }));
  }
  public io.vertx.rxjava.core.net.NetSocket exceptionHandler(io.vertx.core.Handler handler) { 
    delegate.exceptionHandler(handler);
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket handler(io.vertx.core.Handler handler) { 
    delegate.handler(new Handler() {
      public void handle(io.vertx.core.buffer.Buffer event) {
        handler.handle(io.vertx.rxjava.core.buffer.Buffer.newInstance((io.vertx.core.buffer.Buffer)event));
      }
    });
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket pause() { 
    delegate.pause();
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket resume() { 
    delegate.resume();
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket fetch(long amount) { 
    delegate.fetch(amount);
    return this;
  }
  /**
   * 
   * 
   * This handler might be called after the close handler when the socket is paused and there are still
   * buffers to deliver.
   * @param endHandler 
   * @return 
   */
  public io.vertx.rxjava.core.net.NetSocket endHandler(io.vertx.core.Handler endHandler) { 
    delegate.endHandler(endHandler);
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket setWriteQueueMaxSize(int maxSize) { 
    delegate.setWriteQueueMaxSize(maxSize);
    return this;
  }
  public io.vertx.rxjava.core.net.NetSocket drainHandler(io.vertx.core.Handler handler) { 
    delegate.drainHandler(handler);
    return this;
  }
  /**
   * When a NetSocket is created it automatically registers an event handler with the event bus, the ID of that
   * handler is given by writeHandlerID.
   * 
   * Given this ID, a different event loop can send a buffer to that event handler using the event bus and
   * that buffer will be received by this instance in its own event loop and written to the underlying connection. This
   * allows you to write data to other connections which are owned by different event loops.
   * @return the write handler ID
   */
  public java.lang.String writeHandlerID() { 
    java.lang.String ret = delegate.writeHandlerID();
    return ret;
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   * @param handler 
   */
  public void write(java.lang.String str, io.vertx.core.Handler> handler) { 
    delegate.write(str, handler);
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   */
  public void write(java.lang.String str) {
    write(str, ar -> { });
  }
    /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   * @return 
   */
  public rx.Single rxWrite(java.lang.String str) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      write(str, fut);
    }));
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   * @param enc 
   * @param handler 
   */
  public void write(java.lang.String str, java.lang.String enc, io.vertx.core.Handler> handler) { 
    delegate.write(str, enc, handler);
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   * @param enc 
   */
  public void write(java.lang.String str, java.lang.String enc) {
    write(str, enc, ar -> { });
  }
    /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#write} but with an handler called when the operation completes
   * @param str 
   * @param enc 
   * @return 
   */
  public rx.Single rxWrite(java.lang.String str, java.lang.String enc) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      write(str, enc, fut);
    }));
  }
  /**
   * Like {@link io.vertx.rxjava.core.streams.WriteStream#write} but with an handler called when the message has been written
   * or failed to be written.
   * @param message 
   * @param handler 
   */
  public void write(io.vertx.rxjava.core.buffer.Buffer message, io.vertx.core.Handler> handler) { 
    delegate.write(message.getDelegate(), handler);
  }
  /**
   * Like {@link io.vertx.rxjava.core.streams.WriteStream#write} but with an handler called when the message has been written
   * or failed to be written.
   * @param message 
   */
  public void write(io.vertx.rxjava.core.buffer.Buffer message) {
    write(message, ar -> { });
  }
    /**
   * Like {@link io.vertx.rxjava.core.streams.WriteStream#write} but with an handler called when the message has been written
   * or failed to be written.
   * @param message 
   * @return 
   */
  public rx.Single rxWrite(io.vertx.rxjava.core.buffer.Buffer message) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      write(message, fut);
    }));
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param resultHandler handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename, io.vertx.core.Handler> resultHandler) { 
    delegate.sendFile(filename, resultHandler);
    return this;
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename) {
    return 
sendFile(filename, ar -> { });
  }
    /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @return a reference to this, so the API can be used fluently
   */
  public rx.Single rxSendFile(java.lang.String filename) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      sendFile(filename, fut);
    }));
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @param resultHandler handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename, long offset, io.vertx.core.Handler> resultHandler) { 
    delegate.sendFile(filename, offset, resultHandler);
    return this;
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename, long offset) {
    return 
sendFile(filename, offset, ar -> { });
  }
    /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @return a reference to this, so the API can be used fluently
   */
  public rx.Single rxSendFile(java.lang.String filename, long offset) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      sendFile(filename, offset, fut);
    }));
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @param length length
   * @param resultHandler handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename, long offset, long length, io.vertx.core.Handler> resultHandler) { 
    delegate.sendFile(filename, offset, length, resultHandler);
    return this;
  }
  /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @param length length
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket sendFile(java.lang.String filename, long offset, long length) {
    return 
sendFile(filename, offset, length, ar -> { });
  }
    /**
   * Same as {@link io.vertx.rxjava.core.net.NetSocket#sendFile} but also takes a handler that will be called when the send has completed or
   * a failure has occurred
   * @param filename file name of the file to send
   * @param offset offset
   * @param length length
   * @return a reference to this, so the API can be used fluently
   */
  public rx.Single rxSendFile(java.lang.String filename, long offset, long length) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      sendFile(filename, offset, length, fut);
    }));
  }
  /**
   * @return the remote address for this connection, possibly null (e.g a server bound on a domain socket). If useProxyProtocol is set to true, the address returned will be of the actual connecting client.
   */
  public io.vertx.rxjava.core.net.SocketAddress remoteAddress() { 
    if (cached_0 != null) {
      return cached_0;
    }
    io.vertx.rxjava.core.net.SocketAddress ret = io.vertx.rxjava.core.net.SocketAddress.newInstance((io.vertx.core.net.SocketAddress)delegate.remoteAddress());
    cached_0 = ret;
    return ret;
  }
  /**
   * @return the local address for this connection, possibly null (e.g a server bound on a domain socket) If useProxyProtocol is set to true, the address returned will be of the proxy.
   */
  public io.vertx.rxjava.core.net.SocketAddress localAddress() { 
    if (cached_1 != null) {
      return cached_1;
    }
    io.vertx.rxjava.core.net.SocketAddress ret = io.vertx.rxjava.core.net.SocketAddress.newInstance((io.vertx.core.net.SocketAddress)delegate.localAddress());
    cached_1 = ret;
    return ret;
  }
  /**
   * Calls {@link io.vertx.rxjava.core.net.NetSocket#end}.
   * @param handler 
   */
  public void end(io.vertx.core.Handler> handler) { 
    delegate.end(handler);
  }
  /**
   * Calls {@link io.vertx.rxjava.core.net.NetSocket#end}.
   */
  public void end() {
    end(ar -> { });
  }
    /**
   * Calls {@link io.vertx.rxjava.core.net.NetSocket#end}.
   * @return 
   */
  public rx.Single rxEnd() { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      end(fut);
    }));
  }
  /**
   * Close the NetSocket and notify the handler when the operation completes.
   * @param handler 
   */
  public void close(io.vertx.core.Handler> handler) { 
    delegate.close(handler);
  }
  /**
   * Close the NetSocket and notify the handler when the operation completes.
   */
  public void close() {
    close(ar -> { });
  }
    /**
   * Close the NetSocket and notify the handler when the operation completes.
   * @return 
   */
  public rx.Single rxClose() { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      close(fut);
    }));
  }
  /**
   * Set a handler that will be called when the NetSocket is closed
   * @param handler the handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket closeHandler(io.vertx.core.Handler handler) { 
    delegate.closeHandler(handler);
    return this;
  }
  /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @param handler the handler will be notified when it's upgraded
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket upgradeToSsl(io.vertx.core.Handler> handler) { 
    delegate.upgradeToSsl(handler);
    return this;
  }
  /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket upgradeToSsl() {
    return 
upgradeToSsl(ar -> { });
  }
    /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @return a reference to this, so the API can be used fluently
   */
  public rx.Single rxUpgradeToSsl() { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      upgradeToSsl(fut);
    }));
  }
  /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @param serverName the server name
   * @param handler the handler will be notified when it's upgraded
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket upgradeToSsl(java.lang.String serverName, io.vertx.core.Handler> handler) { 
    delegate.upgradeToSsl(serverName, handler);
    return this;
  }
  /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @param serverName the server name
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.net.NetSocket upgradeToSsl(java.lang.String serverName) {
    return 
upgradeToSsl(serverName, ar -> { });
  }
    /**
   * Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
   * @param serverName the server name
   * @return a reference to this, so the API can be used fluently
   */
  public rx.Single rxUpgradeToSsl(java.lang.String serverName) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      upgradeToSsl(serverName, fut);
    }));
  }
  /**
   * @return true if this {@link io.vertx.rxjava.core.net.NetSocket} is encrypted via SSL/TLS.
   */
  public boolean isSsl() { 
    boolean ret = delegate.isSsl();
    return ret;
  }
  /**
   * Returns the SNI server name presented during the SSL handshake by the client.
   * @return the indicated server name
   */
  public java.lang.String indicatedServerName() { 
    java.lang.String ret = delegate.indicatedServerName();
    return ret;
  }
  /**
   * @return the application-level protocol negotiated during the TLS handshake
   */
  public java.lang.String applicationLayerProtocol() { 
    java.lang.String ret = delegate.applicationLayerProtocol();
    return ret;
  }
  /**
   * @return SSLSession associated with the underlying socket. Returns null if connection is not SSL.
   */
  public javax.net.ssl.SSLSession sslSession() { 
    javax.net.ssl.SSLSession ret = delegate.sslSession();
    return ret;
  }
  private io.vertx.rxjava.core.net.SocketAddress cached_0;
  private io.vertx.rxjava.core.net.SocketAddress cached_1;
  public static NetSocket newInstance(io.vertx.core.net.NetSocket arg) {
    return arg != null ? new NetSocket(arg) : null;
  }
}