# sponge

**Repository Path**: info-superbahn-ict/sponge

## Basic Information

- **Project Name**: sponge
- **Description**: code of sponge
(blackboard)
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: gx-dev-test
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-28
- **Last Updated**: 2024-09-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 信息高铁blackboard中关于redis部分的说明


 

# 1 部署说明

## 1.1 linux下部署安装redis

* wget http://download.redis.io/releases/redis-5.0.8.tar.gz

* tar xzf redis-5.0.8.tar.gz  

* cd redis-5.0.8

* make

## 1.2 启动redis服务

* cd src

* ./redis-server

## 1.3 也可以通过参数告诉redis使用指定配置启动

* ./redis-server ../redis.conf

## 1.4 连接redis

* ./redis-cli

## 1.5 redis命令

* redis其他常用命令可以参考：https://www.runoob.com/redis/redis-keys.html

## 1.6 Windows下部署和启动redis

部署redis：redis官方不建议在Windows上使用redis，但Microsoft维护了一个Windows版本（3.0）

* https://github.com/MicrosoftArchive/redis/releases

* 选择 Redis-x64-3.0.504.msi，按照默认流程安装Redis

启动redis

* 在管理员权限下启动命令行cmd

* redis-server --service-start


# 2 接口方法说明

## 1.1 设备注册（registerDevice）
>
    /**  
     * 在黑板中注册一个新设备  
     * @param registerInfo: 注册信息  
     * @return ID：信息高铁中的设备ID    
     */  
    String registerDevice(RegisterInfo registerInfo);  

## 1.2 设备注销（deleteDevice）
>
    /**  
     * 在黑板中删除一个新设备  
     * @param ID 信息高铁中的设备ID  
     * @return 执行状态  
     */ 
    InteractiveStatusEnum deleteDevice(String ID);  

## 1.3 设备心跳（renewalDevice）
>   
    /**   
     * 已存在设备的心跳   
     * 建议续约时间: 2s  
     * @param ID 信息高铁中的设备ID  
     * @return 执行状态  
     */  
    InteractiveStatusEnum renewalDevice(String ID);

## 1.4 断线重连（reconnect）
>   
    /**  
     * 重新连接到黑板  
     * @param ID 信息高铁中的设备ID  
     * @return 执行状态  
     */  
    InteractiveStatusEnum reconnect(String ID);

## 1.5 获取注册信息（getRegisterInfo）
>   
    /**  
     * 获取注册信息   
     * @param guId 信息高铁中的设备ID  
     * @return 注册信息json字符串  
     */  
    String getRegisterInfo(String guId);

## 1.6 获取所有设备ID（getAllDeviceIds）
>   
    /**  
     * 获取所有设备ID   
     * @param 
     * @return 设备ID列表  
     */  
    List<String> getAllDeviceIds();

## 1.7 获取所有设备信息（getAllDeviceInfos）
>   
    /**  
     * 获取所有设备信息   
     * @param 
     * @return 设备信息列表  
     */  
    List<DeviceInfo> getAllDeviceInfos();

## 1.8 获取活跃设备ID（getAliveDeviceIds）
>   
    /**  
     * 获取活跃设备ID   
     * @param 
     * @return 活跃设备ID列表  
     */  
    List<String> getAliveDeviceIds();

## 1.9 获取活跃设备信息（getAliveDeviceInfos）
>   
    /**  
     * 获取活跃设备信息   
     * @param 
     * @return 活跃设备信息列表  
     */  
    List<String> getAliveDeviceInfos();

## 2.0 通过关键字查询有关设备（getKeywordDeviceInfos）
>   
    /**  
     * 通过关键字查询有关设备   
     * @param keyword 关键字
     * @return 有关设备信息列表  
     */  
    List<DeviceInfo> getKeywordDeviceInfos(String keyWord);