org.tio.server.proxy

Class ProxyProtocolDecoder

java.lang.Object

org.tio.server.proxy.ProxyProtocolDecoder

public final class ProxyProtocolDecoder
extends Object

开启 nginx 代理协议时需要开启，转发代理 ip 信息

proxy_protocol on;

Author:

L.cm

Method Summary

Modifier and Type	Method and Description
static Packet	decode(ChannelContext context, ByteBuffer buffer, int readableLength, DecoderFunction next) 解码 proxy protocol
static ProxyProtocolMessage	decodeForTest(ByteBuffer buffer, int readableLength) 解码 proxy protocol
static Packet	decodeIfEnable(ChannelContext context, ByteBuffer buffer, int readableLength, DecoderFunction next) 解码，如果开启了 proxy protocol
static ProxyProtocolMessage	decodeMessage(ByteBuffer buffer, int readableLength) 解码 proxy protocol
static void	enableProxyProtocol(ChannelContext context) 开始 proxy protocol
static boolean	isProxyProtocolEnabled(ChannelContext context) 判断是否开启 proxy protocol
static void	removeProxyProtocol(ChannelContext context) 去掉 proxy protocol

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

enableProxyProtocol

public static void enableProxyProtocol(ChannelContext context)

开始 proxy protocol

Parameters:

context - ChannelContext

removeProxyProtocol

public static void removeProxyProtocol(ChannelContext context)

去掉 proxy protocol

Parameters:

context - ChannelContext

isProxyProtocolEnabled

public static boolean isProxyProtocolEnabled(ChannelContext context)

判断是否开启 proxy protocol

Parameters:

context - ChannelContext

Returns:

是否开启

decodeIfEnable

public static Packet decodeIfEnable(ChannelContext context,
                                    ByteBuffer buffer,
                                    int readableLength,
                                    DecoderFunction next)
                             throws TioDecodeException

解码，如果开启了 proxy protocol

Parameters:

context - ChannelContext

buffer - ByteBuffer

readableLength - readableLength

next - 下一个解码器

Returns:

ProxyProtocolMessage

Throws:

TioDecodeException - TioDecodeException

decode

public static Packet decode(ChannelContext context,
                            ByteBuffer buffer,
                            int readableLength,
                            DecoderFunction next)
                     throws TioDecodeException

解码 proxy protocol

Parameters:

context - ChannelContext

buffer - ByteBuffer

readableLength - readableLength

next - 下一个解码器

Returns:

ProxyProtocolMessage

Throws:

TioDecodeException - TioDecodeException

decodeForTest

public static ProxyProtocolMessage decodeForTest(ByteBuffer buffer,
                                                 int readableLength)
                                          throws TioDecodeException

解码 proxy protocol

Parameters:

buffer - ByteBuffer

readableLength - readableLength

Returns:

ProxyProtocolMessage

Throws:

TioDecodeException - TioDecodeException

decodeMessage

public static ProxyProtocolMessage decodeMessage(ByteBuffer buffer,
                                                 int readableLength)
                                          throws TioDecodeException

解码 proxy protocol

Parameters:

buffer - ByteBuffer

readableLength - readableLength

Returns:

ProxyProtocolMessage

Throws:

TioDecodeException - TioDecodeException