NettyChannelContext (Asynchronous Game Query Library 1.2.2 API)

java.lang.Object
- com.ibasco.agql.core.NettyChannelContext

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

Direct Known Subclasses:

MasterServerChannelContext, SourceRconChannelContext
```
@ApiStatus.Internal
public class NettyChannelContext
extends Object
implements Closeable, Cloneable
```
The context attached to a Channel instance

Author:

Rafael Luis Ibasco

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class NettyChannelContext.Properties
Contains all the properties associated with the channel

Nested Classes
Modifier and Type	Class and Description
`class`	`NettyChannelContext.Properties` Contains all the properties associated with the channel

Constructor Summary

Constructors
Modifier	Constructor and Description
	`NettyChannelContext(io.netty.channel.Channel channel, NettyMessenger<? extends AbstractRequest,? extends AbstractResponse> messenger)` Constructor for NettyChannelContext.
`protected`	`NettyChannelContext(NettyChannelContext context)` Constructor for NettyChannelContext.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NettyChannelContext`	`attach(AbstractRequest request)` attach.
`io.netty.channel.Channel`	`channel()` channel.
`protected void`	`cleanup()` Called once the underlying `Channel`/Connection has been closed.
`void`	`clear()` Clear the properties stack
`NettyChannelContext`	`clone()`
`void`	`close()`
`<C extends NettyChannelContext> CompletableFuture<C>`	`composedFuture()` Returns a `CompletableFuture` that returns this context once the response has been marked as completed.
`NettyChannelContext`	`disableAutoRelease()` Disable auto-release of context
`NettyChannelContext`	`disableReadTimeout()` Disable read timeouts.
`NettyChannelContext`	`disableWriteTimeout()` Disable write timeouts
`NettyChannelContext`	`enableAutoRelease()` enableAutoRelease.
`boolean`	`equals(Object o)`
`io.netty.channel.EventLoop`	`eventLoop()` eventLoop.
`<V> boolean`	`exists(io.netty.util.AttributeKey<V> key)` exists.
`CompletableFuture<NettyChannelContext>`	`future()` future.
`<V> V`	`get(io.netty.util.AttributeKey<V> key)` get.
`static NettyChannelContext`	`getContext(io.netty.channel.Channel channel)` Get the channel context attached to the provided `Channel`
`boolean`	`hasError()` hasError.
`int`	`hashCode()`
`boolean`	`hasResponse()` hasResponse.
`String`	`id()` id.
`boolean`	`inEventLoop()` inEventLoop.
`boolean`	`isCompleted()` isCompleted.
`boolean`	`isValid()` isValid.
`InetSocketAddress`	`localAddress()` localAddress.
`void`	`markInError(Throwable error)` markInError.
`boolean`	`markSuccess(AbstractResponse response)` markSuccess.
`NettyMessenger<? extends AbstractRequest,? extends AbstractResponse>`	`messenger()` messenger.
`protected NettyChannelContext.Properties`	`newProperties(NettyChannelContext.Properties copy)` newProperties.
`NettyChannelContext.Properties`	`properties()` properties.
`void`	`receive(AbstractResponse response)` Pass the message back to the messenger.
`void`	`receive(Throwable error)` Pass the error back to the messenger.
`InetSocketAddress`	`remoteAddress()` remoteAddress.
`NettyChannelContext`	`restore()` Restore the previously saved context
`NettyChannelContext`	`save()` Save the current state of this context
`CompletableFuture<? extends NettyChannelContext>`	`send()` send.
`<V> void`	`set(io.netty.util.AttributeKey<V> key, V value)` set.
`String`	`toString()`

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

- Constructor Detail
  - NettyChannelContext
```
public NettyChannelContext(io.netty.channel.Channel channel,
                           NettyMessenger<? extends AbstractRequest,? extends AbstractResponse> messenger)
```
    Constructor for NettyChannelContext.
    
    Parameters:
    
    channel - a Channel object
    
    messenger - a NettyMessenger object
  - NettyChannelContext
```
protected NettyChannelContext(NettyChannelContext context)
```
    Constructor for NettyChannelContext.
    
    Parameters:
    
    context - a NettyChannelContext object
- Method Detail
  - newProperties
```
protected NettyChannelContext.Properties newProperties(NettyChannelContext.Properties copy)
```
    newProperties.
    
    Parameters:
    
    copy - a NettyChannelContext.Properties object
    
    Returns:
    
    a NettyChannelContext.Properties object
  - properties
```
public NettyChannelContext.Properties properties()
```
    properties.
    
    Returns:
    
    a NettyChannelContext.Properties object
  - channel
```
public final io.netty.channel.Channel channel()
```
    channel.
    
    Returns:
    
    a Channel object
  - cleanup
```
protected void cleanup()
```
    Called once the underlying Channel/Connection has been closed.
  - getContext
```
public static NettyChannelContext getContext(io.netty.channel.Channel channel)
```
    Get the channel context attached to the provided Channel
    
    Parameters:
    
    channel - The Channel to retrieve the context from
    
    Returns:
    
    The NettyChannelContext associated with the Channel
  - composedFuture
```
public final <C extends NettyChannelContext> CompletableFuture<C> composedFuture()
```
    Returns a CompletableFuture that returns this context once the response has been marked as completed.
    
    Type Parameters:
    
    C - A captured type of NettyChannelContext
    
    Returns:
    
    a CompletableFuture returning this context instance once response has been received.
  - future
```
public final CompletableFuture<NettyChannelContext> future()
```
    future.
    
    Returns:
    
    a CompletableFuture object
  - eventLoop
```
public final io.netty.channel.EventLoop eventLoop()
```
    eventLoop.
    
    Returns:
    
    a EventLoop object
  - isValid
```
public boolean isValid()
```
    isValid.
    
    Returns:
    
    a boolean
  - messenger
```
public NettyMessenger<? extends AbstractRequest,? extends AbstractResponse> messenger()
```
    messenger.
    
    Returns:
    
    a NettyMessenger object
  - inEventLoop
```
public final boolean inEventLoop()
```
    inEventLoop.
    
    Returns:
    
    a boolean
  - hasResponse
```
public final boolean hasResponse()
```
    hasResponse.
    
    Returns:
    
    a boolean
  - isCompleted
```
public final boolean isCompleted()
```
    isCompleted.
    
    Returns:
    
    a boolean
  - hasError
```
public final boolean hasError()
```
    hasError.
    
    Returns:
    
    a boolean
  - markSuccess
```
public final boolean markSuccess(AbstractResponse response)
```
    markSuccess.
    
    Parameters:
    
    response - a AbstractResponse object
    
    Returns:
    
    a boolean
  - receive
```
public final void receive(AbstractResponse response)
```
    Pass the message back to the messenger. Note this will not mark the promise as completed.
    
    Parameters:
    
    response - The AbstractResponse to receive
  - id
```
public final String id()
```
    id.
    
    Returns:
    
    a String object
  - markInError
```
public final void markInError(Throwable error)
```
    markInError.
    
    Parameters:
    
    error - a Throwable object
  - receive
```
public final void receive(Throwable error)
```
    Pass the error back to the messenger. Note this will not mark the promise as completed.
    
    Parameters:
    
    error - The Throwable to receive
  - exists
```
public final <V> boolean exists(io.netty.util.AttributeKey<V> key)
```
    exists.
    
    Type Parameters:
    
    V - a V class
    
    Parameters:
    
    key - a AttributeKey object
    
    Returns:
    
    a boolean
  - get
```
public final <V> V get(io.netty.util.AttributeKey<V> key)
```
    get.
    
    Type Parameters:
    
    V - a V class
    
    Parameters:
    
    key - a AttributeKey object
    
    Returns:
    
    a V object
  - set
```
public final <V> void set(io.netty.util.AttributeKey<V> key,
                          V value)
```
    set.
    
    Type Parameters:
    
    V - a V class
    
    Parameters:
    
    key - a AttributeKey object
    
    value - a V object
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    remoteAddress.
    
    Returns:
    
    a InetSocketAddress object
  - localAddress
```
public InetSocketAddress localAddress()
```
    localAddress.
    
    Returns:
    
    a InetSocketAddress object
  - send
```
public CompletableFuture<? extends NettyChannelContext> send()
```
    send.
    
    Returns:
    
    a CompletableFuture object
  - save
```
public NettyChannelContext save()
```
    Save the current state of this context
    
    Returns:
    
    This NettyChannelContext
  - restore
```
public NettyChannelContext restore()
```
    Restore the previously saved context
    
    Returns:
    
    This NettyChannelContext
  - clear
```
public void clear()
```
    Clear the properties stack
  - attach
```
public NettyChannelContext attach(AbstractRequest request)
```
    attach.
    
    Parameters:
    
    request - a AbstractRequest object
    
    Returns:
    
    a NettyChannelContext object
  - enableAutoRelease
```
public NettyChannelContext enableAutoRelease()
```
    enableAutoRelease.
    
    Returns:
    
    a NettyChannelContext object
  - disableAutoRelease
```
public NettyChannelContext disableAutoRelease()
```
    Disable auto-release of context
    
    Returns:
    
    a NettyChannelContext object
  - disableWriteTimeout
```
public NettyChannelContext disableWriteTimeout()
```
    Disable write timeouts
    
    Returns:
    
    a NettyChannelContext object
  - disableReadTimeout
```
public NettyChannelContext disableReadTimeout()
```
    Disable read timeouts.
    
    Returns:
    
    a NettyChannelContext object
  - close
```
public void close()
```
    Close or release the underlying Channel of this context. If the Channel is not pooled, it will call ChannelOutboundInvoker.close() otherwise it will attempt to call release to return it back to the pool.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NettyChannelContext clone()
```
    Overrides:
    
    clone in class Object

Class NettyChannelContext

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NettyChannelContext

NettyChannelContext

Method Detail

newProperties

properties

channel

cleanup

getContext

composedFuture

future

eventLoop

isValid

messenger

inEventLoop

hasResponse

isCompleted

hasError

markSuccess

receive

id

markInError

receive

exists

get

set

remoteAddress

localAddress

send

save

restore

clear

attach

enableAutoRelease

disableAutoRelease

disableWriteTimeout

disableReadTimeout

close

toString

equals

hashCode

clone