104 lines
2.6 KiB
Markdown
104 lines
2.6 KiB
Markdown
# Object - TSessionMan 会话管理
|
|
|
|
## `TSessionMan`
|
|
|
|
声明：class
|
|
|
|
用于创建、查找、维护和删除服务端会话的内置对象
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 查找 搜索 lookup 对象 实例 -->
|
|
|
|
### `create()`
|
|
|
|
声明：function
|
|
|
|
创建 TSessionMan 实例
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 创建 生成 对象 实例 -->
|
|
|
|
可见性：public
|
|
|
|
### `deleteSession(id, session_id)`
|
|
|
|
声明：function
|
|
|
|
删除会话
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 删除 移除 对象 实例 -->
|
|
|
|
可见性：public
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
| --- | --- | --- |
|
|
| `id` | string | 字符串类型，用来进行唯一标示的串。开发中，大多情况下使用用户名 |
|
|
| `session_id` | string | 可选。字符串类型，会话标识，如果会话ID不设置，则可为任何SessionId |
|
|
|
|
返回：any
|
|
|
|
### `getSession(id, session_id)`
|
|
|
|
声明：function
|
|
|
|
获取一个已有的会话
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 -->
|
|
|
|
可见性：public
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
| --- | --- | --- |
|
|
| `id` | string | 字符串类型，用来进行唯一标示的串。开发中，大多情况下使用用户名 |
|
|
| `session_id` | string | 可选。字符串类型，会话标识，如果会话ID不设置，则可为任何SessionId |
|
|
|
|
返回：TSession
|
|
|
|
### `newSession(id, max_session)`
|
|
|
|
声明：function
|
|
|
|
创建一个会话
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 创建 生成 对象 实例 -->
|
|
|
|
可见性：public
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
| --- | --- | --- |
|
|
| `id` | string | 字符串类型，用来进行唯一标示的串。开发中，大多情况下使用用户名 |
|
|
| `max_session` | integer | 可选。整数类型，指定的Id最多允许的会话个数。开发中，大多数情况下采用允许的登录次数。如果省略，则表示不限制会话的个数 |
|
|
|
|
返回：TSession
|
|
|
|
### `onlineSession(id, strings)`
|
|
|
|
声明：function
|
|
|
|
获取指定用户的在线会话列表，一般用于调试用
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 -->
|
|
|
|
可见性：public
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
| --- | --- | --- |
|
|
| `id` | string | 字符串类型，用来进行唯一标示的串。开发中，大多情况下使用用户名 |
|
|
| `strings` | TStringList | TStrings类型，用来存贮用户（ID）列表 |
|
|
|
|
返回：any
|
|
|
|
### `onlineUser(strings)`
|
|
|
|
声明：function
|
|
|
|
获取在线的ID列表
|
|
|
|
<!-- tags: Object TSessionMan 会话管理 获取 查询 对象 实例 ID -->
|
|
|
|
可见性：public
|
|
|
|
| 参数 | 类型 | 说明 |
|
|
| --- | --- | --- |
|
|
| `strings` | TStringList | TStrings类型，用来存贮用户（ID）列表 |
|
|
|
|
返回：any
|