RakChannelOption (transport-raknet 1.0.0.CR3-SNAPSHOT API)

java.lang.Object
- io.netty.util.AbstractConstant<io.netty.channel.ChannelOption<T>>
- - io.netty.channel.ChannelOption<T>
  - - org.cloudburstmc.netty.channel.raknet.config.RakChannelOption<T>

All Implemented Interfaces:

io.netty.util.Constant<io.netty.channel.ChannelOption<T>>, java.lang.Comparable<io.netty.channel.ChannelOption<T>>
```
public class RakChannelOption<T>
extends io.netty.channel.ChannelOption<T>
```

Field Summary

Fields
Modifier and Type	Field and Description
`static io.netty.channel.ChannelOption<io.netty.buffer.ByteBuf>`	`RAK_ADVERTISEMENT` The advertisement sent to clients pinging a server.
`static io.netty.channel.ChannelOption<java.lang.Boolean>`	`RAK_AUTO_FLUSH` Whether RakNet will flush outgoing messages autoamatically every RAK_FLUSH_INTERVAL or flushing has to be triggered by the user.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_CLIENT_INTERNAL_ADDRESSES` The amount of internal addresses to send from the client in New Incoming Connection packets.
`static io.netty.channel.ChannelOption<java.lang.Boolean>`	`RAK_COMPATIBILITY_MODE` Whether the client should be run in compatibility mode for closer behavior to the vanilla client RakNet implementation.
`static io.netty.channel.ChannelOption<java.lang.Long>`	`RAK_CONNECT_TIMEOUT` Timeout delay used during client offline phase in millis.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_FLUSH_INTERVAL` Interval in milliseconds of how often auto flushing should happen.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_GLOBAL_PACKET_LIMIT` A number of all datagrams that will be handled within one RakNet tick before server starts dropping any incoming data.
`static io.netty.channel.ChannelOption<java.lang.Long>`	`RAK_GUID` Unique ID of the RakNet peer sent.
`static io.netty.channel.ChannelOption<java.lang.Boolean>`	`RAK_HANDLE_PING` Enables custom handling for RakNet packets in the server implementation.
`static io.netty.channel.ChannelOption<java.lang.Boolean>`	`RAK_IP_DONT_FRAGMENT` Whether to use the IP_DONT_FRAGMENT option for the client channel.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MAX_CHANNELS` TODO: max amount of child channels per server
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MAX_CONNECTIONS` Maximum allowed connections to the RakNet server.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MAX_MTU` Maximum allowed MTU that the RakNet server connection can use
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MAX_QUEUED_BYTES` Maximum amount of bytes that can be queued in a single RakNet session.
`static io.netty.channel.ChannelOption<RakChannelMetrics>`	`RAK_METRICS` RakMetrics instance used for session
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MIN_MTU` Minimum allowed MTU that the RakNet server connection can use
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_MTU` MTU that the RakNet client will use when initially connecting.
`static io.netty.channel.ChannelOption<java.lang.Integer[]>`	`RAK_MTU_SIZES` An array of MTU sizes that the RakNet client will use when initially connecting.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_ORDERING_CHANNELS` Maximum amount of ordering channels each RakNet connection can have.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_PACKET_LIMIT` A number of datagram packets each address can send within one RakNet tick (10ms).
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_PROTOCOL_VERSION` RakNet protocol version to send to remote peer.
`static io.netty.channel.ChannelOption<java.lang.Long>`	`RAK_REMOTE_GUID` Unique ID of the remote RakNet peer sent.
`static io.netty.channel.ChannelOption<RakServerCookieMode>`	`RAK_SERVER_COOKIE_MODE` The cookie mode the RakNet server will use when handling client connections.
`static io.netty.channel.ChannelOption<byte[]>`	`RAK_SERVER_COOKIE_SECRET`
`static io.netty.channel.ChannelOption<RakServerMetrics>`	`RAK_SERVER_METRICS` RakMetrics instance used for server
`static io.netty.channel.ChannelOption<java.lang.Long>`	`RAK_SESSION_TIMEOUT` Time after session is closed due to no activity.
`static io.netty.channel.ChannelOption<int[]>`	`RAK_SUPPORTED_PROTOCOLS` Versions supported by the RakNet server.
`static io.netty.channel.ChannelOption<java.lang.Integer>`	`RAK_TIME_BETWEEN_SEND_CONNECTION_ATTEMPTS_MS` The time between the client sending connection attempts in milliseconds.
`static io.netty.channel.ChannelOption<io.netty.buffer.ByteBuf>`	`RAK_UNCONNECTED_MAGIC` Magic used to make unconnected packets unique.

Fields inherited from class io.netty.channel.ChannelOption
ALLOCATOR, ALLOW_HALF_CLOSURE, AUTO_CLOSE, AUTO_READ, CONNECT_TIMEOUT_MILLIS, DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION, IP_MULTICAST_ADDR, IP_MULTICAST_IF, IP_MULTICAST_LOOP_DISABLED, IP_MULTICAST_TTL, IP_TOS, MAX_MESSAGES_PER_READ, MAX_MESSAGES_PER_WRITE, MESSAGE_SIZE_ESTIMATOR, RCVBUF_ALLOCATOR, SINGLE_EVENTEXECUTOR_PER_GROUP, SO_BACKLOG, SO_BROADCAST, SO_KEEPALIVE, SO_LINGER, SO_RCVBUF, SO_REUSEADDR, SO_SNDBUF, SO_TIMEOUT, TCP_FASTOPEN, TCP_FASTOPEN_CONNECT, TCP_NODELAY, WRITE_BUFFER_HIGH_WATER_MARK, WRITE_BUFFER_LOW_WATER_MARK, WRITE_BUFFER_WATER_MARK, WRITE_SPIN_COUNT

Constructor Summary

Constructors
Modifier Constructor and Description

protected RakChannelOption()

Constructors
Modifier	Constructor and Description
`protected`	`RakChannelOption()`

Method Summary
- Methods inherited from class io.netty.channel.ChannelOption
  exists, newInstance, validate, valueOf, valueOf
- Methods inherited from class io.netty.util.AbstractConstant
  compareTo, equals, hashCode, id, name, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - RAK_MAX_CHANNELS
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MAX_CHANNELS
```
    TODO: max amount of child channels per server
  - RAK_ORDERING_CHANNELS
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_ORDERING_CHANNELS
```
    Maximum amount of ordering channels each RakNet connection can have. (1-256)
  - RAK_MTU
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MTU
```
    MTU that the RakNet client will use when initially connecting.
  - RAK_MAX_MTU
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MAX_MTU
```
    Maximum allowed MTU that the RakNet server connection can use
  - RAK_MIN_MTU
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MIN_MTU
```
    Minimum allowed MTU that the RakNet server connection can use
  - RAK_GUID
```
public static final io.netty.channel.ChannelOption<java.lang.Long> RAK_GUID
```
    Unique ID of the RakNet peer sent.
  - RAK_REMOTE_GUID
```
public static final io.netty.channel.ChannelOption<java.lang.Long> RAK_REMOTE_GUID
```
    Unique ID of the remote RakNet peer sent. Usually used in client implementation.
  - RAK_MAX_CONNECTIONS
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MAX_CONNECTIONS
```
    Maximum allowed connections to the RakNet server. Subsequent connections will be denied.
  - RAK_PROTOCOL_VERSION
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_PROTOCOL_VERSION
```
    RakNet protocol version to send to remote peer.
  - RAK_SUPPORTED_PROTOCOLS
```
public static final io.netty.channel.ChannelOption<int[]> RAK_SUPPORTED_PROTOCOLS
```
    Versions supported by the RakNet server.
    By default, all protocol versions will be supported.
  - RAK_UNCONNECTED_MAGIC
```
public static final io.netty.channel.ChannelOption<io.netty.buffer.ByteBuf> RAK_UNCONNECTED_MAGIC
```
    Magic used to make unconnected packets unique.
  - RAK_CONNECT_TIMEOUT
```
public static final io.netty.channel.ChannelOption<java.lang.Long> RAK_CONNECT_TIMEOUT
```
    Timeout delay used during client offline phase in millis.
  - RAK_METRICS
```
public static final io.netty.channel.ChannelOption<RakChannelMetrics> RAK_METRICS
```
    RakMetrics instance used for session
  - RAK_SERVER_METRICS
```
public static final io.netty.channel.ChannelOption<RakServerMetrics> RAK_SERVER_METRICS
```
    RakMetrics instance used for server
  - RAK_ADVERTISEMENT
```
public static final io.netty.channel.ChannelOption<io.netty.buffer.ByteBuf> RAK_ADVERTISEMENT
```
    The advertisement sent to clients pinging a server.
  - RAK_HANDLE_PING
```
public static final io.netty.channel.ChannelOption<java.lang.Boolean> RAK_HANDLE_PING
```
    Enables custom handling for RakNet packets in the server implementation.
  - RAK_SESSION_TIMEOUT
```
public static final io.netty.channel.ChannelOption<java.lang.Long> RAK_SESSION_TIMEOUT
```
    Time after session is closed due to no activity.
  - RAK_AUTO_FLUSH
```
public static final io.netty.channel.ChannelOption<java.lang.Boolean> RAK_AUTO_FLUSH
```
    Whether RakNet will flush outgoing messages autoamatically every RAK_FLUSH_INTERVAL or flushing has to be triggered by the user.
  - RAK_FLUSH_INTERVAL
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_FLUSH_INTERVAL
```
    Interval in milliseconds of how often auto flushing should happen. Default is 10ms.
  - RAK_PACKET_LIMIT
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_PACKET_LIMIT
```
    A number of datagram packets each address can send within one RakNet tick (10ms). Default is 120 packets.
  - RAK_GLOBAL_PACKET_LIMIT
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_GLOBAL_PACKET_LIMIT
```
    A number of all datagrams that will be handled within one RakNet tick before server starts dropping any incoming data. Default is 100_000 (RAK_PACKET_LIMIT * 0.56 * 1500 different connections).
  - RAK_COMPATIBILITY_MODE
```
public static final io.netty.channel.ChannelOption<java.lang.Boolean> RAK_COMPATIBILITY_MODE
```
    Whether the client should be run in compatibility mode for closer behavior to the vanilla client RakNet implementation.
  - RAK_MTU_SIZES
```
public static final io.netty.channel.ChannelOption<java.lang.Integer[]> RAK_MTU_SIZES
```
    An array of MTU sizes that the RakNet client will use when initially connecting.
  - RAK_IP_DONT_FRAGMENT
```
public static final io.netty.channel.ChannelOption<java.lang.Boolean> RAK_IP_DONT_FRAGMENT
```
    Whether to use the IP_DONT_FRAGMENT option for the client channel.
  - RAK_CLIENT_INTERNAL_ADDRESSES
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_CLIENT_INTERNAL_ADDRESSES
```
    The amount of internal addresses to send from the client in New Incoming Connection packets.
  - RAK_TIME_BETWEEN_SEND_CONNECTION_ATTEMPTS_MS
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_TIME_BETWEEN_SEND_CONNECTION_ATTEMPTS_MS
```
    The time between the client sending connection attempts in milliseconds.
  - RAK_MAX_QUEUED_BYTES
```
public static final io.netty.channel.ChannelOption<java.lang.Integer> RAK_MAX_QUEUED_BYTES
```
    Maximum amount of bytes that can be queued in a single RakNet session.
  - RAK_SERVER_COOKIE_MODE
```
public static final io.netty.channel.ChannelOption<RakServerCookieMode> RAK_SERVER_COOKIE_MODE
```
    The cookie mode the RakNet server will use when handling client connections.
  - RAK_SERVER_COOKIE_SECRET
```
public static final io.netty.channel.ChannelOption<byte[]> RAK_SERVER_COOKIE_SECRET
```
- Constructor Detail
  - RakChannelOption
```
protected RakChannelOption()
```

Class RakChannelOption<T>

Field Summary

Fields inherited from class io.netty.channel.ChannelOption

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.ChannelOption

Methods inherited from class io.netty.util.AbstractConstant

Methods inherited from class java.lang.Object

Field Detail

RAK_MAX_CHANNELS

RAK_ORDERING_CHANNELS

RAK_MTU

RAK_MAX_MTU

RAK_MIN_MTU

RAK_GUID

RAK_REMOTE_GUID

RAK_MAX_CONNECTIONS

RAK_PROTOCOL_VERSION

RAK_SUPPORTED_PROTOCOLS

RAK_UNCONNECTED_MAGIC

RAK_CONNECT_TIMEOUT

RAK_METRICS

RAK_SERVER_METRICS

RAK_ADVERTISEMENT

RAK_HANDLE_PING

RAK_SESSION_TIMEOUT

RAK_AUTO_FLUSH

RAK_FLUSH_INTERVAL

RAK_PACKET_LIMIT

RAK_GLOBAL_PACKET_LIMIT

RAK_COMPATIBILITY_MODE

RAK_MTU_SIZES

RAK_IP_DONT_FRAGMENT

RAK_CLIENT_INTERNAL_ADDRESSES

RAK_TIME_BETWEEN_SEND_CONNECTION_ATTEMPTS_MS

RAK_MAX_QUEUED_BYTES

RAK_SERVER_COOKIE_MODE

RAK_SERVER_COOKIE_SECRET

Constructor Detail

RakChannelOption