Gateway (MobileIMSDK 6.5(Server端) API文档)

java.lang.Object
- net.x52im.mobileimsdk.server.network.Gateway

直接已知子类:

GatewayTCP, GatewayUDP, GatewayWebsocket
```
public abstract class Gateway
extends java.lang.Object
```
网关（用于服务端支持的各种网络通信类型的父类）。

从以下版本开始:

5.0

作者:

Jack Jiang( http://www.52im.net/thread-2792-1-1.html )

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE` 用于用户会话（即Netty中的“Channel”）中存放Socket类型标识的属性key
`static io.netty.util.AttributeKey<java.lang.Integer>`	`SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE_ATTR` 用于用户会话（即Netty中的“Channel”）中存取属性用的AttributeKey
`static int`	`SOCKET_TYPE_TCP` 网络通信类型常量：TCP
`static int`	`SOCKET_TYPE_UDP` 网络通信类型常量：UDP
`static int`	`SOCKET_TYPE_WEBSOCKET` 网络通信类型常量：WebSocket

构造器概要

构造器
构造器和说明

Gateway()

构造器
构造器和说明
`Gateway()`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`static java.lang.String`	`$(io.netty.channel.Channel c)` 返回客户端连接的网络通信类型的字符串描述，主要用于Debug中。
`abstract void`	`bind()` 绑定端口、启动服务。
`static java.lang.String`	`getGatewayFlag(io.netty.channel.Channel c)` 返回客户端连接的网络通信类型的字符串描述，主要用于Debug中。
`static int`	`getSocketType(io.netty.channel.Channel c)` 获取该Channel中存放的网络类型标识。
`abstract void`	`init(ServerCoreHandler serverCoreHandler)` 初始化。
`static boolean`	`isSupportTCP(int support)` 是否支持TCP。
`static boolean`	`isSupportUDP(int support)` 是否支持UDP。
`static boolean`	`isSupportWebSocket(int support)` 是否支持WebSocket。
`static boolean`	`isTCPChannel(io.netty.channel.Channel c)` 客户端连接是否是TCP。
`static boolean`	`isUDPChannel(io.netty.channel.Channel c)` 客户端连接是否是UDP。
`static boolean`	`isWebSocketChannel(io.netty.channel.Channel c)` 客户端连接是否是WebSocket。
`static void`	`removeSocketType(io.netty.channel.Channel c)` 清除该Channel网络类型标识。
`static void`	`setSocketType(io.netty.channel.Channel c, int socketType)` 为该Channel设置网络类型标识（因为MobileIMSDK支持多种网络通信类型）。
`abstract void`	`shutdown()` 关闭服务并释放资源。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE
```
public static final java.lang.String SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE
```
    用于用户会话（即Netty中的“Channel”）中存放Socket类型标识的属性key
    
    另请参阅:
    
    常量字段值
  - SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE_ATTR
```
public static final io.netty.util.AttributeKey<java.lang.Integer> SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE_ATTR
```
    用于用户会话（即Netty中的“Channel”）中存取属性用的AttributeKey
  - SOCKET_TYPE_UDP
```
public static final int SOCKET_TYPE_UDP
```
    网络通信类型常量：UDP
    
    另请参阅:
    
    常量字段值
  - SOCKET_TYPE_TCP
```
public static final int SOCKET_TYPE_TCP
```
    网络通信类型常量：TCP
    
    另请参阅:
    
    常量字段值
  - SOCKET_TYPE_WEBSOCKET
```
public static final int SOCKET_TYPE_WEBSOCKET
```
    网络通信类型常量：WebSocket
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - Gateway
```
public Gateway()
```
- 方法详细资料
  - init
```
public abstract void init(ServerCoreHandler serverCoreHandler)
```
    初始化。
    
    参数:
    
    serverCoreHandler -
  - bind
```
public abstract void bind()
                   throws java.lang.Exception
```
    绑定端口、启动服务。
    
    抛出:
    
    java.lang.Exception
  - shutdown
```
public abstract void shutdown()
```
    关闭服务并释放资源。
  - setSocketType
```
public static void setSocketType(io.netty.channel.Channel c,
                                 int socketType)
```
    为该Channel设置网络类型标识（因为MobileIMSDK支持多种网络通信类型）。
    
    参数:
    
    c - 通信会话Channel对象引用
    
    socketType - 网络类型标识
    
    另请参阅:
    
    SOCKET_TYPE_UDP, SOCKET_TYPE_TCP, SOCKET_TYPE_WEBSOCKET
  - removeSocketType
```
public static void removeSocketType(io.netty.channel.Channel c)
```
    清除该Channel网络类型标识。
    
    参数:
    
    c - 通信会话Channel对象引用
  - getSocketType
```
public static int getSocketType(io.netty.channel.Channel c)
```
    获取该Channel中存放的网络类型标识。
    
    参数:
    
    c - 通信会话Channel对象引用
    
    返回:
    
    如果成功取到则正常返回网络类型标识常量，否则返回-1
    
    另请参阅:
    
    SOCKET_TYPE_UDP, SOCKET_TYPE_TCP, SOCKET_TYPE_WEBSOCKET
  - isSupportUDP
```
public static boolean isSupportUDP(int support)
```
    是否支持UDP。
    
    参数:
    
    support -
    
    返回:
  - isSupportTCP
```
public static boolean isSupportTCP(int support)
```
    是否支持TCP。
    
    参数:
    
    support -
    
    返回:
  - isSupportWebSocket
```
public static boolean isSupportWebSocket(int support)
```
    是否支持WebSocket。
    
    参数:
    
    support -
    
    返回:
    
    从以下版本开始:
    
    6.0
  - isTCPChannel
```
public static boolean isTCPChannel(io.netty.channel.Channel c)
```
    客户端连接是否是TCP。
    
    参数:
    
    c -
    
    返回:
  - isUDPChannel
```
public static boolean isUDPChannel(io.netty.channel.Channel c)
```
    客户端连接是否是UDP。
    
    参数:
    
    c -
    
    返回:
  - isWebSocketChannel
```
public static boolean isWebSocketChannel(io.netty.channel.Channel c)
```
    客户端连接是否是WebSocket。
    
    参数:
    
    c -
    
    返回:
  - $
```
public static java.lang.String $(io.netty.channel.Channel c)
```
    返回客户端连接的网络通信类型的字符串描述，主要用于Debug中。
    
    参数:
    
    c -
    
    返回:
  - getGatewayFlag
```
public static java.lang.String getGatewayFlag(io.netty.channel.Channel c)
```
    返回客户端连接的网络通信类型的字符串描述，主要用于Debug中。
    
    参数:
    
    c -
    
    返回:

类 Gateway

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE

SOCKET_TYPE_IN_CHANNEL_ATTRIBUTE_ATTR

SOCKET_TYPE_UDP

SOCKET_TYPE_TCP

SOCKET_TYPE_WEBSOCKET

构造器详细资料

Gateway

方法详细资料

init

bind

shutdown

setSocketType

removeSocketType

getSocketType

isSupportUDP

isSupportTCP

isSupportWebSocket

isTCPChannel

isUDPChannel

isWebSocketChannel

$

getGatewayFlag