TCPSocket (async-net 1.0.2 API)

java.lang.Object
- me.melchor9000.net.Socket
- - me.melchor9000.net.TCPSocket

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class TCPSocket
extends Socket
```
TCP Socket for connexions to servers.

This implementation creates a TCP Socket for client only connections. To use the Socket you must connect to a remote endpoint using one of the available connect or connectAsync methods available. It is not recommended to call any bind methods because it will replace the current socket (if it is connected) with a new not connected.

Receive operations will return when there is some data, that is, it will not ensure read an exact quantity of bytes. Receive operations stores all unread data into an intermediary Buffer. When it is full, new data gets discarded. Internal buffer, normally, has capacity for 146KB (not KiB). To know if there's bytes to read, you can call readableBytes().

Send operations will send directly to the remote endpoint, flushing anything pending to send. This also depends on if Nagle's Algorithm is enabled or not.

A TCP Connection can shutdown the output or the input or both streams. This can also be accomplished with shutdownOutput(), shutdownOutputAsync(), shutdownInput(), shutdownInputAsync(), shutdown() or shutdownAsync().

When closed, all write and read operations will fail. Socket.isOpen() will return null. Is possible to be notified when the socket is closed, by you or by the remote endpoint, using onClose(), or the synchronous version waitUntilClose().

Field Summary
- Fields inherited from class me.melchor9000.net.Socket
  bootstrap, bytesRead, bytesWrote, channel, service

Constructor Summary

Constructors
Constructor and Description

TCPSocket(IOService service)
Creates a new TCP Socket

Constructors
Constructor and Description
`TCPSocket(IOService service)` Creates a new TCP Socket

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bind(java.net.SocketAddress address)` Binds the socket to a local address.
`void`	`close()` Closes the socket after the current operation is done.
`Future<java.lang.Void>`	`closeAsync()` Closes the socket after the current operation is done, and then calls `cbk` with the result, either successful or failure.
`void`	`connect(java.net.SocketAddress address)` Binds the socket to a random port and connects to the remote endpoint.
`Future<java.lang.Void>`	`connectAsync(java.net.SocketAddress endpoint)` Binds the socket to a random port and connects to the remote endpoint asynchronously.
`Future<java.lang.Void>`	`onClose()` Returns a `Future` that will complete when this socket is closed.
`int`	`readableBytes()`
`long`	`receive(io.netty.buffer.ByteBuf data, int bytes)` Receives some data from the socket and writes it into the `ByteBuf` `data` a maximum of `bytes` bytes.
`Future<java.lang.Long>`	`receiveAsync(io.netty.buffer.ByteBuf data, int bytes)` Receives some data from the socket and writes it into the `ByteBuf` `data` a maximum of `bytes` bytes.
`void`	`shutdown()` Ends the input and output stream of this connection, but not closes the connection.
`Future<java.lang.Void>`	`shutdownAsync()` Ends the input and output stream of this connection, but not closes the connection.
`void`	`shutdownInput()` Ends the input stream of this connection, discarding any pending data to be acknowledged.
`Future<java.lang.Void>`	`shutdownInputAsync()` Ends the input stream of this connection, discarding any pending data to be acknowledged.
`void`	`shutdownOutput()` Ends the output stream of this connection, sending before any data pending to send.
`Future<java.lang.Void>`	`shutdownOutputAsync()` Ends the output stream of this connection, sending before any data pending to send.
`void`	`waitUntilClose()` Waits until this socket is closed.

Methods inherited from class me.melchor9000.net.Socket
addOnDataReceivedListener, bind, checkSocketCreated, connect, connect, connectAsync, connectAsync, createFuture, createFuture, fireReceivedData, isOpen, localEndpoint, receive, receiveAsync, receivedBytes, remoteEndpoint, send, send, send, sendAsync, sendAsync, sendAsync, sendBytes, setOption

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TCPSocket
```
public TCPSocket(IOService service)
```
    Creates a new TCP Socket
    
    Parameters:
    
    service - IOService to attach this socket
- Method Detail
  - bind
```
public void bind(java.net.SocketAddress address)
```
    Description copied from class: Socket
    
    Binds the socket to a local address. Depending on the implementation, this could fail.
    
    Overrides:
    
    bind in class Socket
    
    Parameters:
    
    address - address to bind
  - connect
```
public void connect(java.net.SocketAddress address)
             throws java.lang.InterruptedException
```
    Description copied from class: Socket
    
    Binds the socket to a random port and connects to the remote endpoint.
    
    Overrides:
    
    connect in class Socket
    
    Parameters:
    
    address - remote endpoint
    
    Throws:
    
    java.lang.InterruptedException - When this Thread is interrupted
  - connectAsync
```
public Future<java.lang.Void> connectAsync(java.net.SocketAddress endpoint)
```
    Description copied from class: Socket
    
    Binds the socket to a random port and connects to the remote endpoint asynchronously. Returns a Future where the task can be managed.
    
    Overrides:
    
    connectAsync in class Socket
    
    Parameters:
    
    endpoint - remote endpoint to connect
    
    Returns:
    
    Future of the task
  - receive
```
public long receive(io.netty.buffer.ByteBuf data,
                    int bytes)
             throws java.lang.Throwable
```
    Description copied from class: Socket
    
    Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes. This method don't read exactly bytes bytes, only at most. To ensure read all the bytes, use one of the SocketUtil methods.
    
    Specified by:
    
    receive in class Socket
    
    Parameters:
    
    data - buffer where to write on all the data
    
    bytes - maximum number of bytes to read
    
    Returns:
    
    number of bytes read currently
    
    Throws:
    
    java.lang.Throwable - if the receive operation fails, throws something
  - receiveAsync
```
public Future<java.lang.Long> receiveAsync(io.netty.buffer.ByteBuf data,
                                           int bytes)
```
    Description copied from class: Socket
    
    Receives some data from the socket and writes it into the ByteBuf data a maximum of bytes bytes. This method don't read exactly bytes bytes, only at most. To ensure read all the bytes, use one of the SocketUtil methods. This operation is done asynchronously, so returns a Future for the task.
    
    Specified by:
    
    receiveAsync in class Socket
    
    Parameters:
    
    data - buffer where to write on all the data
    
    bytes - maximum number of bytes to read
    
    Returns:
    
    a Future representing this task
  - shutdownOutput
```
public void shutdownOutput()
```
    Ends the output stream of this connection, sending before any data pending to send. After shutdown, any attempt to send anything will fail with an IOException.
  - shutdownOutputAsync
```
public Future<java.lang.Void> shutdownOutputAsync()
```
    Ends the output stream of this connection, sending before any data pending to send. After shutdown, any attempt to send anything will fail with an IOException.
    
    Returns:
    
    Future of this task
  - shutdownInput
```
public void shutdownInput()
```
    Ends the input stream of this connection, discarding any pending data to be acknowledged. Any attempt to receive some data will fail with an IOException or returning -1. IOException.
  - shutdownInputAsync
```
public Future<java.lang.Void> shutdownInputAsync()
```
    Ends the input stream of this connection, discarding any pending data to be acknowledged. Any attempt to receive some data will fail with an IOException or returning -1. IOException.
    
    Returns:
    
    Future of this task
  - shutdown
```
public void shutdown()
```
    Ends the input and output stream of this connection, but not closes the connection.
    
    See Also:
    
    About shutdown the input stream, About shutdown the Output stream
  - shutdownAsync
```
public Future<java.lang.Void> shutdownAsync()
```
    Ends the input and output stream of this connection, but not closes the connection.
    
    Returns:
    
    Future of this task
    
    See Also:
    
    About shutdown the input stream, About shutdown the Output stream
  - readableBytes
```
public int readableBytes()
```
    Returns:
    
    the number of bytes that can be read, or -1 if EOF
  - waitUntilClose
```
public void waitUntilClose()
```
    Waits until this socket is closed. Any interruption won't affect the wait.
  - onClose
```
public Future<java.lang.Void> onClose()
```
    Returns a Future that will complete when this socket is closed.
    
    Returns:
    
    a Future for the task
  - close
```
public void close()
```
    Description copied from class: Socket
    
    Closes the socket after the current operation is done. It can throw an Throwable if an error occurs. This operation blocks the thread.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class Socket
  - closeAsync
```
public Future<java.lang.Void> closeAsync()
```
    Description copied from class: Socket
    
    Closes the socket after the current operation is done, and then calls cbk with the result, either successful or failure.
    
    Overrides:
    
    closeAsync in class Socket
    
    Returns:
    
    Future about the task

Class TCPSocket

Field Summary

Fields inherited from class me.melchor9000.net.Socket

Constructor Summary

Method Summary

Methods inherited from class me.melchor9000.net.Socket

Methods inherited from class java.lang.Object

Constructor Detail

TCPSocket

Method Detail

bind

connect

connectAsync

receive

receiveAsync

shutdownOutput

shutdownOutputAsync

shutdownInput

shutdownInputAsync

shutdown

shutdownAsync

readableBytes

waitUntilClose

onClose

close

closeAsync