PyroClient (Telegram Api 57.2 API)

java.lang.Object
- jawnae.pyronet.PyroClient

```
public class PyroClient
extends Object
```

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(PyroClientListener listener)`
`void`	`attach(Object attachment)` Attach any object to a client, for example to store session information
`<T> T`	`attachment()` Returns the previously attached object, or `null` if none is set
`void`	`dropConnection()` Immediately drop the connection, regardless of any pending outbound bytes.
`int`	`flush()` Writes as many as possible bytes to the socket buffer
`int`	`flushOrDie()` Makes an attempt to write all outbound bytes, fails on failure.
`InetSocketAddress`	`getLocalAddress()` Returns the local socket address (host+port)
`InetSocketAddress`	`getRemoteAddress()` Returns the remove socket address (host+port)
`boolean`	`hasDataEnqueued()` Returns whether there are bytes left in the outbound queue.
`boolean`	`isDisconnected()` Returns whether the connection is connected to a remote client.
`void`	`removeListener(PyroClientListener listener)`
`void`	`removeListeners()`
`PyroSelector`	`selector()` Returns the PyroSelector that created this client
`void`	`setEagerWrite(boolean enabled)` If enabled, causes calls to write() to make an attempt to write the bytes, without waiting for the selector to signal writable state.
`void`	`setKeepAlive(boolean enabled)`
`void`	`setLinger(boolean enabled, int seconds)`
`void`	`setTimeout(int ms)`
`void`	`shutdown()` Gracefully shuts down the connection.
`String`	`toString()`
`void`	`write(ByteBufferDesc data)` Will enqueue the bytes to send them 1.

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

- Method Detail
  - addListener
```
public void addListener(PyroClientListener listener)
```
  - removeListener
```
public void removeListener(PyroClientListener listener)
```
  - removeListeners
```
public void removeListeners()
```
  - selector
```
public PyroSelector selector()
```
    Returns the PyroSelector that created this client
  - attach
```
public void attach(Object attachment)
```
    Attach any object to a client, for example to store session information
  - attachment
```
public <T> T attachment()
```
    Returns the previously attached object, or null if none is set
  - getLocalAddress
```
public InetSocketAddress getLocalAddress()
```
    Returns the local socket address (host+port)
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    Returns the remove socket address (host+port)
  - setTimeout
```
public void setTimeout(int ms)
                throws IOException
```
    Throws:
    
    IOException
  - setLinger
```
public void setLinger(boolean enabled,
                      int seconds)
               throws IOException
```
    Throws:
    
    IOException
  - setKeepAlive
```
public void setKeepAlive(boolean enabled)
                  throws IOException
```
    Throws:
    
    IOException
  - setEagerWrite
```
public void setEagerWrite(boolean enabled)
```
    If enabled, causes calls to write() to make an attempt to write the bytes, without waiting for the selector to signal writable state.
  - write
```
public void write(ByteBufferDesc data)
           throws PyroException
```
    Will enqueue the bytes to send them
    1. when the selector is ready to write, if eagerWrite is disabled (default)
    2. immediately, if eagerWrite is enabled
    The ByteBuffer instance is kept, not copied, and thus should not be modified
    
    Throws:
    
    PyroException - when shutdown() has been called.
  - flush
```
public int flush()
```
    Writes as many as possible bytes to the socket buffer
  - flushOrDie
```
public int flushOrDie()
               throws PyroException
```
    Makes an attempt to write all outbound bytes, fails on failure.
    
    Throws:
    
    PyroException - on failure
  - hasDataEnqueued
```
public boolean hasDataEnqueued()
```
    Returns whether there are bytes left in the outbound queue.
  - shutdown
```
public void shutdown()
```
    Gracefully shuts down the connection. The connection is closed after the last outbound bytes are sent. Enqueuing new bytes after shutdown, is not allowed and will throw an exception
  - dropConnection
```
public void dropConnection()
```
    Immediately drop the connection, regardless of any pending outbound bytes. Actual behaviour depends on the socket linger settings.
  - isDisconnected
```
public boolean isDisconnected()
```
    Returns whether the connection is connected to a remote client.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PyroClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addListener

removeListener

removeListeners

selector

attach

attachment

getLocalAddress

getRemoteAddress

setTimeout

setLinger

setKeepAlive

setEagerWrite

write

flush

flushOrDie

hasDataEnqueued

shutdown

dropConnection

isDisconnected

toString