libcolutius
Server类 参考

IRC服务器类 更多...

#include <Server.h>

类 Server 继承关系图:

Public 类型

enum  Status { Connected , Disconnected }
 服务器当前状态 更多...
 
enum  Type { Tcp , Ssl }
 

信号

void loginSuccess (Server *server)
 服务器连接成功 更多...
 
void loginFail ()
 服务器连接失败 更多...
 
void disconnected ()
 服务器断开连接 更多...
 
void networkError ()
 网络未连接 更多...
 
void networkOk ()
 网络已连接 更多...
 
void addSessionSucess ()
 会话加入成功 更多...
 
void addSessionCallBack (QString name)
 内部信号 更多...
 

Public 成员函数

 Server (Type type=Tcp, QString host="", int port=0, QString nick="", QString user="", QString passwd="", QObject *parent=nullptr)
 有参构造, 更多...
 
 ~Server () override
 默认析构函数 更多...
 
void login ()
 连接到服务器并向服务器发送登录信息,如果登录成功,则发射loginSuccess信号 更多...
 
void disconnect ()
 断开服务器连接 更多...
 
void setHost (QString host)
 设置服务器地址 更多...
 
void setPort (int port)
 设置端口号 更多...
 
void setNick (QString nick)
 设置昵称 更多...
 
void setUser (QString user)
 设置用户名 更多...
 
void setPasswd (QString passwd)
 设置密码 更多...
 
QString getNick ()
 获取昵称 更多...
 
QString getHost ()
 获取服务器地址 更多...
 
void receiveData ()
 接收数据 更多...
 
void addSession (const QString &name)
 添加会话,加入成功后发射addSessionSucess信号 更多...
 
QList< Message * > getMessageList ()
 获取服务器消息列表 更多...
 
MessagegetMessage (int index)
 根据索引获取消息实例 更多...
 
SessiongetSession (int index)
 根据索引获取会话实例 更多...
 
SessiongetSession (QString name)
 根据会话名称获取会话实例 更多...
 
QList< Session * > getSessionList ()
 获取服务器会话列表 更多...
 
int getMessageNum ()
 获取服务器消息数目 更多...
 
int getSessionNum ()
 获取服务器会话数目 更多...
 
void sendMsg (Message *message)
 发送消息,传入的Message实例一定要手动设置session 更多...
 

详细描述

IRC服务器类

成员枚举类型说明

◆ Status

服务器当前状态

枚举值
Connected 

服务器已连接

Disconnected 

服务器断开连接

◆ Type

服务器连接类型

枚举值
Tcp 

TCP Socket

Ssl 

SSL Socket

构造及析构函数说明

◆ Server()

Server::Server ( Server::Type  type = Tcp,
QString  host = "",
int  port = 0,
QString  nick = "",
QString  user = "",
QString  passwd = "",
QObject *  parent = nullptr 
)
explicit

有参构造,

参数
type服务器连接类型,Tcp或Ssl,默认为Tcp
host服务器地址,默认为空
port服务器端口号,默认为0
nick昵称,默认为空
user用户名,默认为空
passwd密码,默认为空
parent默认为nullptr

◆ ~Server()

Server::~Server ( )
override

默认析构函数

成员函数说明

◆ addSession()

void Server::addSession ( const QString &  name)

添加会话,加入成功后发射addSessionSucess信号

参数
name会话名称

◆ addSessionCallBack

void Server::addSessionCallBack ( QString  name)
signal

内部信号

◆ addSessionSucess

void Server::addSessionSucess ( )
signal

会话加入成功

◆ disconnect()

void Server::disconnect ( )

断开服务器连接

◆ disconnected

void Server::disconnected ( )
signal

服务器断开连接

◆ getHost()

QString Server::getHost ( )

获取服务器地址

返回
服务器地址

◆ getMessage()

Message * Server::getMessage ( int  index)

根据索引获取消息实例

参数
index消息索引号
返回
Message类型的消息实例

◆ getMessageList()

QList< Message * > Server::getMessageList ( )

获取服务器消息列表

返回
QList类型的消息列表

◆ getMessageNum()

int Server::getMessageNum ( )

获取服务器消息数目

返回
消息数目

◆ getNick()

QString Server::getNick ( )

获取昵称

返回
当前昵称

◆ getSession() [1/2]

Session * Server::getSession ( int  index)

根据索引获取会话实例

参数
index会话索引号
返回
Session类型的会话实例

◆ getSession() [2/2]

Session * Server::getSession ( QString  name)

根据会话名称获取会话实例

参数
name会话名称
返回
如果会话存在,返回Session类型的会话实例,否则返回nullptr

◆ getSessionList()

QList< Session * > Server::getSessionList ( )

获取服务器会话列表

返回
QList类型的会话列表

◆ getSessionNum()

int Server::getSessionNum ( )

获取服务器会话数目

返回
会话数目

◆ login()

void Server::login ( )

连接到服务器并向服务器发送登录信息,如果登录成功,则发射loginSuccess信号

◆ loginFail

void Server::loginFail ( )
signal

服务器连接失败

◆ loginSuccess

void Server::loginSuccess ( Server server)
signal

服务器连接成功

◆ networkError

void Server::networkError ( )
signal

网络未连接

◆ networkOk

void Server::networkOk ( )
signal

网络已连接

◆ receiveData()

void Server::receiveData ( )

接收数据

switch (message->getNum()) { case 376: emit loginSuccess(this); break; case 366: emit addSessionCallBack(message->getSession()); break; default: break; }

◆ sendMsg()

void Server::sendMsg ( Message message)

发送消息,传入的Message实例一定要手动设置session

参数
messageMessage类型的消息实例
session消息要发送到的会话

◆ setHost()

void Server::setHost ( QString  host)

设置服务器地址

参数
host服务器地址

◆ setNick()

void Server::setNick ( QString  nick)

设置昵称

参数
nick昵称

◆ setPasswd()

void Server::setPasswd ( QString  passwd)

设置密码

参数
passwd密码

◆ setPort()

void Server::setPort ( int  port)

设置端口号

参数
port端口号

◆ setUser()

void Server::setUser ( QString  user)

设置用户名

参数
user用户名

该类的文档由以下文件生成: