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

java.lang.Object
- net.x52im.mobileimsdk.server.processor.OnlineProcessor

```
public class OnlineProcessor
extends java.lang.Object
```
MobileIMSDK的服务端用户列表管理类。
根据全局算法约定，当user_id=0时即表示是服务器。
注意：由于历史原因，MobileIMSDK中的“会话”当前等同于Netty中的“Channel”，你可以认为代码中提到这两个名词时指的是同一个东西。

版本:

3.1

作者:

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

字段概要

字段
限定符和类型	字段和说明
`static io.netty.util.AttributeKey<java.lang.Integer>`	`ATTRIBUTE_KEY_BE_KICKOUT_CODE` 用于用户会话（即Netty中的“Channel”）中存取该会话中存放的被踢原因码用的AttributeKey
`static io.netty.util.AttributeKey<java.lang.Long>`	`ATTRIBUTE_KEY_FIRST_LOGIN_TIME` 用于用户会话（即Netty中的“Channel”）中存取该会话对应的首次登陆时间时用的AttributeKey
`static io.netty.util.AttributeKey<java.lang.String>`	`ATTRIBUTE_KEY_USER_ID` 用于用户会话（即Netty中的“Channel”）中存取该会话对应的user_id时用的AttributeKey
`static boolean`	`DEBUG`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`__printOnline()` 打印在线用户列。
`static int`	`getBeKickoutCodeFromChannel(io.netty.channel.Channel session)` 尝试取出存放于用户会话中的被踢原因编码.
`static long`	`getFirstLoginTimeFromChannel(io.netty.channel.Channel session)` 尝试取出存放于用户会话中的首次登陆时间.
`static OnlineProcessor`	`getInstance()` 为了简化API调用，本方法将以单例的形式存活。
`io.netty.channel.Channel`	`getOnlineSession(java.lang.String user_id)` 根据user_id获得该在线用户对应的 Netty UDP Channel 会话实例句柄。
`java.util.concurrent.ConcurrentMap<java.lang.String,io.netty.channel.Channel>`	`getOnlineSessions()` 返回用户在线列表：key=user_id、value=会话实例引用。
`static java.lang.String`	`getUserIdFromChannel(io.netty.channel.Channel session)` 尝试取出存放于用户会话中的user_id.
`static boolean`	`isLogined(io.netty.channel.Channel session)` 该用户会话是否是合法的（已登陆认证）。
`static boolean`	`isOnline(java.lang.String userId)` 指定用户ID的用户是否在线。
`boolean`	`putUser(java.lang.String user_id, long firstLoginTime, io.netty.channel.Channel newSession)` 将用户放入在线列表。
`static void`	`removeAttributesForChannel(io.netty.channel.Channel session)` 从指定的“会话”中清除之前保存在Channel中的Attribute属性（这一般用于会话注销等情况）。
`boolean`	`removeUser(java.lang.String user_id)` 将用户从在线列表中移除.
`static void`	`setBeKickoutCodeForChannel(io.netty.channel.Channel session, int beKickoutCode)` 为指定的“会话”设置被踢原因码。
`static void`	`setFirstLoginTimeForChannel(io.netty.channel.Channel session, long firstLoginTime)` 为指定的“会话”设置首次登陆时间（后绪代码可据此时间更准确地处理多端互踢逻辑）。
`static void`	`setUserIdForChannel(io.netty.channel.Channel session, java.lang.String userId)` 为指定的“会话”设置它对应的用户ID（后绪代码可据用户ID此判定此Channel的身份）。

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

- 字段详细资料
  - ATTRIBUTE_KEY_USER_ID
```
public static final io.netty.util.AttributeKey<java.lang.String> ATTRIBUTE_KEY_USER_ID
```
    用于用户会话（即Netty中的“Channel”）中存取该会话对应的user_id时用的AttributeKey
  - ATTRIBUTE_KEY_FIRST_LOGIN_TIME
```
public static final io.netty.util.AttributeKey<java.lang.Long> ATTRIBUTE_KEY_FIRST_LOGIN_TIME
```
    用于用户会话（即Netty中的“Channel”）中存取该会话对应的首次登陆时间时用的AttributeKey
  - ATTRIBUTE_KEY_BE_KICKOUT_CODE
```
public static final io.netty.util.AttributeKey<java.lang.Integer> ATTRIBUTE_KEY_BE_KICKOUT_CODE
```
    用于用户会话（即Netty中的“Channel”）中存取该会话中存放的被踢原因码用的AttributeKey
  - DEBUG
```
public static boolean DEBUG
```
- 方法详细资料
  - getInstance
```
public static OnlineProcessor getInstance()
```
    为了简化API调用，本方法将以单例的形式存活。
    
    返回:
    
    本类的全局单例
  - putUser
```
public boolean putUser(java.lang.String user_id,
                       long firstLoginTime,
                       io.netty.channel.Channel newSession)
```
    将用户放入在线列表。
    从 v6.0开始，本方法增加了同一账号多端登陆互踢的逻辑，且互踢逻辑考虑了复杂网络变动下的多端互踢判定方法，防止误判误踢）。本次互踢思路，请见我在此帖中的回复：http://www.52im.net/thread-2879-1-1.html
    本方法由MobileIMSDK内部决定如何调用，不建议开发者调用此方法！
    
    参数:
    
    user_id - 用户的user_id
    
    firstLoginTime - 用户的首次登陆时间（如果是首次登陆则此值是<=0，否则为标准java时间戳）
    
    newSession - 该用户对应的 Netty Channel 对象
    
    返回:
    
    true表示该会话正常加入在线列表，否则未被加入在线列表（这种情况下的会话应该是已被踢出的会话(此次是重连时过来的)，具体原因请见本方法中的代码逻辑实现）
  - __printOnline
```
public void __printOnline()
```
    打印在线用户列。
    本方法仅应用于DEBUG时，当在线用户数量众多时，本方法会影响性能。
  - removeUser
```
public boolean removeUser(java.lang.String user_id)
```
    将用户从在线列表中移除.
    本方法由MobileIMSDK内部决定如何调用，不建议开发者调用此方法！
    
    参数:
    
    user_id - 用户的user_id
    
    返回:
    
    true表示已成功remove，否则表示没有此user_id对应的在线信息
  - getOnlineSession
```
public io.netty.channel.Channel getOnlineSession(java.lang.String user_id)
```
    根据user_id获得该在线用户对应的 Netty UDP Channel 会话实例句柄。
    
    参数:
    
    user_id - 用户的user_id
    
    返回:
    
    存在该在线用户则成功返回，否则返回null
  - getOnlineSessions
```
public java.util.concurrent.ConcurrentMap<java.lang.String,io.netty.channel.Channel> getOnlineSessions()
```
    返回用户在线列表：key=user_id、value=会话实例引用。
    
    返回:
    
    在线列表实例引用
  - isLogined
```
public static boolean isLogined(io.netty.channel.Channel session)
```
    该用户会话是否是合法的（已登陆认证）。
    根据MINA的原理，任何请求都会建立会话，但会话是否是合法的，则需根据存放于其会话中的登陆属性来校验（MobileIMSDK中，已经过登陆认证的会话，会在其session中存放user_id，判断是否已设置user_id即可认定是否是合法的会话）。
    
    参数:
    
    session - 用户会话引用
    
    返回:
    
    true表示已经成功登陆认证过，否则表示未登陆过（非法请求）
  - isOnline
```
public static boolean isOnline(java.lang.String userId)
```
    指定用户ID的用户是否在线。
    
    参数:
    
    userId - 用户ID
    
    返回:
    
    true表示该用户在线，否则不在线
    
    从以下版本开始:
    
    3.0
  - setUserIdForChannel
```
public static void setUserIdForChannel(io.netty.channel.Channel session,
                                       java.lang.String userId)
```
    为指定的“会话”设置它对应的用户ID（后绪代码可据用户ID此判定此Channel的身份）。
    
    参数:
    
    session - 用户会话引用
    
    userId - 用户ID
    
    从以下版本开始:
    
    6.0
  - setFirstLoginTimeForChannel
```
public static void setFirstLoginTimeForChannel(io.netty.channel.Channel session,
                                               long firstLoginTime)
```
    为指定的“会话”设置首次登陆时间（后绪代码可据此时间更准确地处理多端互踢逻辑）。
    
    参数:
    
    session - 用户会话引用
    
    firstLoginTime - 首次登陆时间（“首次登陆”区分于断线重连，指的是第1次真正的“登陆认证”时）
    
    从以下版本开始:
    
    6.0
  - setBeKickoutCodeForChannel
```
public static void setBeKickoutCodeForChannel(io.netty.channel.Channel session,
                                              int beKickoutCode)
```
    为指定的“会话”设置被踢原因码。
    目前主要用于同一账号多端登陆互踢逻辑中，用于会话close前标记之，方便 ServerEventListener.onUserLogout(String, Channel, int) 回调中可以区分该次logout事件是否源码“被踢”，以及具体的被踢原因，从而在应用层展开更丰富的逻辑处理。
    
    参数:
    
    session - 用户会话引用
    
    beKickoutCode - 被踢原因编码，编码请见 PKickoutInfo类中的常量定义
    
    从以下版本开始:
    
    6.2
    
    另请参阅:
    
    ServerEventListener.onUserLogout(String, Channel, int), PKickoutInfo
  - getUserIdFromChannel
```
public static java.lang.String getUserIdFromChannel(io.netty.channel.Channel session)
```
    尝试取出存放于用户会话中的user_id.
    通常只有已成功登陆验证后的用户会话中才会存放它对应的user_id.
    
    参数:
    
    session - 用户会话引用
    
    返回:
    
    如果找到该属性则返回指定session的user_id，否则返回null
  - getFirstLoginTimeFromChannel
```
public static long getFirstLoginTimeFromChannel(io.netty.channel.Channel session)
```
    尝试取出存放于用户会话中的首次登陆时间.
    
    参数:
    
    session - 用户会话引用
    
    返回:
    
    如果找到该属性则返回正常值，否则返回-1
  - getBeKickoutCodeFromChannel
```
public static int getBeKickoutCodeFromChannel(io.netty.channel.Channel session)
```
    尝试取出存放于用户会话中的被踢原因编码.
    
    参数:
    
    session - 用户会话引用
    
    返回:
    
    如果找到该属性则返回正常值，否则返回-1
    
    从以下版本开始:
    
    6.2
  - removeAttributesForChannel
```
public static void removeAttributesForChannel(io.netty.channel.Channel session)
```
    从指定的“会话”中清除之前保存在Channel中的Attribute属性（这一般用于会话注销等情况）。
    
    参数:
    
    session - 用户会话引用

类 OnlineProcessor

字段概要

方法概要

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

字段详细资料

ATTRIBUTE_KEY_USER_ID

ATTRIBUTE_KEY_FIRST_LOGIN_TIME

ATTRIBUTE_KEY_BE_KICKOUT_CODE

DEBUG

方法详细资料

getInstance

putUser

__printOnline

removeUser

getOnlineSession

getOnlineSessions

isLogined

isOnline

setUserIdForChannel

setFirstLoginTimeForChannel

setBeKickoutCodeForChannel

getUserIdFromChannel

getFirstLoginTimeFromChannel

getBeKickoutCodeFromChannel

removeAttributesForChannel