io.jsync.net.NetSocket Maven / Gradle / Ivy
Show all versions of jsync.io Show documentation
/*
* Copyright (c) 2011-2013 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.jsync.net;
import io.jsync.AsyncResult;
import io.jsync.Handler;
import io.jsync.buffer.Buffer;
import io.jsync.streams.ReadStream;
import io.jsync.streams.WriteStream;
import java.net.InetSocketAddress;
/**
* Represents a socket-like interface to a TCP/SSL 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.jsync.streams.Pump} to pump data with flow control.
* Instances of this class are not thread-safe.
*
* @author Tim Fox
*/
public interface NetSocket extends ReadStream, WriteStream {
/**
* When a {@code NetSocket} is created it automatically registers an event handler with the event bus, the ID of that
* handler is given by {@code 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.
*/
String writeHandlerID();
/**
* Write a {@link Buffer} to the request body.
*
* @return A reference to this, so multiple method calls can be chained.
*/
NetSocket write(Buffer data);
/**
* Write a {@link String} to the connection, encoded in UTF-8.
*
* @return A reference to this, so multiple method calls can be chained.
*/
NetSocket write(String str);
/**
* Write a {@link String} to the connection, encoded using the encoding {@code enc}.
*
* @return A reference to this, so multiple method calls can be chained.
*/
NetSocket write(String str, String enc);
/**
* Tell the kernel 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.
*/
NetSocket sendFile(String filename);
/**
* Same as {@link #sendFile(String)} but also takes a handler that will be called when the send has completed or
* a failure has occurred
*/
NetSocket sendFile(String filename, Handler> resultHandler);
/**
* Return the remote address for this socket
*/
InetSocketAddress remoteAddress();
/**
* Return the local address for this socket
*/
InetSocketAddress localAddress();
/**
* Close the NetSocket
*/
void close();
/**
* Set a handler that will be called when the NetSocket is closed
*/
NetSocket closeHandler(Handler handler);
/**
* Upgrade channel to use SSL/TLS. Be aware that for this to work SSL must be configured.
*/
NetSocket ssl(Handler handler);
/**
* Returns {@code true} if this {@link NetSocket} is encrypted via SSL/TLS.
*/
boolean isSsl();
}