io.vertx.core.net.NetSocket Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.core.net;
import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.streams.ReadStream;
import io.vertx.core.streams.WriteStream;
import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;
import javax.security.cert.X509Certificate;
import java.security.cert.Certificate;
import java.util.List;
/**
* 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 NetClient}
* when a connection to a server is made, or on the server side by a {@link NetServer}
* when a server accepts a connection.
*
* It implements both {@link ReadStream} and {@link WriteStream} so it can be used with
* {@link io.vertx.core.streams.Pipe} to pipe data with flow control.
*
* @author Tim Fox
*/
@VertxGen
public interface NetSocket extends ReadStream, WriteStream {
@Override
NetSocket exceptionHandler(Handler handler);
@Override
NetSocket handler(Handler handler);
@Override
NetSocket pause();
@Override
NetSocket resume();
@Override
NetSocket fetch(long amount);
/**
* {@inheritDoc}
*
* This handler might be called after the close handler when the socket is paused and there are still
* buffers to deliver.
*/
@Override
NetSocket endHandler(Handler endHandler);
@Override
NetSocket setWriteQueueMaxSize(int maxSize);
@Override
NetSocket drainHandler(Handler handler);
/**
* When a {@code NetSocket} is created, it may register an event handler with the event bus, the ID of that
* handler is given by {@code writeHandlerID}.
*
* By default, no handler is registered, the feature must be enabled via {@link NetClientOptions#setRegisterWriteHandler(boolean)} or {@link NetServerOptions#setRegisterWriteHandler(boolean)}.
*
* 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
* @see NetClientOptions#setRegisterWriteHandler(boolean)
* @see NetServerOptions#setRegisterWriteHandler(boolean)
*/
String writeHandlerID();
/**
* Same as {@link #write(String)} but with an {@code handler} called when the operation completes
*/
void write(String str, Handler> handler);
/**
* Write a {@link String} to the connection, encoded in UTF-8.
*
* @param str the string to write
* @return a future result of the write
*/
Future write(String str);
/**
* Same as {@link #write(String, String)} but with an {@code handler} called when the operation completes
*/
void write(String str, String enc, Handler> handler);
/**
* Write a {@link String} to the connection, encoded using the encoding {@code enc}.
*
* @param str the string to write
* @param enc the encoding to use
* @return a future completed with the result
*/
Future write(String str, String enc);
/**
* Like {@link #write(Object)} but with an {@code handler} called when the message has been written
* or failed to be written.
*/
void write(Buffer message, Handler> handler);
/**
* Tell the operating system to stream a file as specified by {@code filename} directly from disk to the outgoing connection,
* bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.
*
* @param filename file name of the file to send
* @return a future result of the send operation
*/
default Future sendFile(String filename) {
return sendFile(filename, 0, Long.MAX_VALUE);
}
/**
* Tell the operating system to stream a file as specified by {@code filename} directly from disk to the outgoing connection,
* bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.
*
* @param filename file name of the file to send
* @param offset offset
* @return a future result of the send operation
*/
default Future sendFile(String filename, long offset) {
return sendFile(filename, offset, Long.MAX_VALUE);
}
/**
* Tell the operating system to stream a file as specified by {@code filename} directly from disk to the outgoing connection,
* bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to stream files.
*
* @param filename file name of the file to send
* @param offset offset
* @param length length
* @return a future result of the send operation
*/
Future sendFile(String filename, long offset, long length);
/**
* Same as {@link #sendFile(String)} 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
*/
@Fluent
default NetSocket sendFile(String filename, Handler> resultHandler) {
return sendFile(filename, 0, Long.MAX_VALUE, resultHandler);
}
/**
* Same as {@link #sendFile(String, long)} 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
*/
@Fluent
default NetSocket sendFile(String filename, long offset, Handler> resultHandler) {
return sendFile(filename, offset, Long.MAX_VALUE, resultHandler);
}
/**
* Same as {@link #sendFile(String, long, long)} 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
*/
@Fluent
NetSocket sendFile(String filename, long offset, long length, Handler> resultHandler);
/**
* @return the remote address for this connection, possibly {@code null} (e.g a server bound on a domain socket).
* If {@code useProxyProtocol} is set to {@code true}, the address returned will be of the actual connecting client.
*/
@CacheReturn
SocketAddress remoteAddress();
/**
* Like {@link #remoteAddress()} but returns the proxy remote address when {@code real} is {@code true}
*/
SocketAddress remoteAddress(boolean real);
/**
* @return the local address for this connection, possibly {@code null} (e.g a server bound on a domain socket)
* If {@code useProxyProtocol} is set to {@code true}, the address returned will be of the proxy.
*/
@CacheReturn
SocketAddress localAddress();
/**
* Like {@link #localAddress()} ()} but returns the server local address when {@code real} is {@code true}
*/
SocketAddress localAddress(boolean real);
/**
* Calls {@link #close()}
*
* @return a future completed with the result
*/
@Override
Future end();
/**
* Calls {@link #end()}.
*/
@Override
void end(Handler> handler);
/**
* Close the NetSocket
*
* @return a future completed with the result
*/
Future close();
/**
* Close the NetSocket and notify the {@code handler} when the operation completes.
*/
void close(Handler> handler);
/**
* 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
*/
@Fluent
NetSocket closeHandler(@Nullable Handler handler);
/**
* 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
*/
@Fluent
NetSocket upgradeToSsl(Handler> handler);
/**
* Like {@link #upgradeToSsl(Handler)} but returns a {@code Future} of the asynchronous result
*/
Future upgradeToSsl();
/**
* 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
*/
@Fluent
NetSocket upgradeToSsl(String serverName, Handler> handler);
/**
* Like {@link #upgradeToSsl(String, Handler)} but returns a {@code Future} of the asynchronous result
*/
Future upgradeToSsl(String serverName);
/**
* @return true if this {@link io.vertx.core.net.NetSocket} is encrypted via SSL/TLS.
*/
boolean isSsl();
/**
* @return SSLSession associated with the underlying socket. Returns null if connection is
* not SSL.
* @see javax.net.ssl.SSLSession
*/
@GenIgnore(GenIgnore.PERMITTED_TYPE)
SSLSession sslSession();
/**
* @return an ordered array of the peer certificates. Returns null if connection is
* not SSL.
* @throws javax.net.ssl.SSLPeerUnverifiedException SSL peer's identity has not been verified.
* @see javax.net.ssl.SSLSession#getPeerCertificateChain()
* @see #sslSession()
* @deprecated instead use {@link #peerCertificates()} or {@link #sslSession()}
*/
@Deprecated
@GenIgnore
X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException;
/**
* @return an ordered list of the peer certificates. Returns null if connection is
* not SSL.
* @throws javax.net.ssl.SSLPeerUnverifiedException SSL peer's identity has not been verified.
* @see javax.net.ssl.SSLSession#getPeerCertificateChain()
* @see #sslSession()
*/
@GenIgnore()
List peerCertificates() throws SSLPeerUnverifiedException;
/**
* Returns the SNI server name presented during the SSL handshake by the client.
*
* @return the indicated server name
*/
String indicatedServerName();
/**
* @return the application-level protocol negotiated during the TLS handshake
*/
String applicationLayerProtocol();
}