QWebSocketCorsAuthenticator 类

QWebSocketCorsAuthenticator class provides an authenticator object for Cross Origin Requests (CORS). 更多...

头: #include <QWebSocketCorsAuthenticator>
qmake: QT += websockets
Since: Qt 5.3

公共函数

QWebSocketCorsAuthenticator (const QString & origin )
QWebSocketCorsAuthenticator (const QWebSocketCorsAuthenticator & other )
QWebSocketCorsAuthenticator (QWebSocketCorsAuthenticator && other )
~QWebSocketCorsAuthenticator ()
bool allowed () const
QString origin () const
void setAllowed (bool allowed )
void swap (QWebSocketCorsAuthenticator & other )
QWebSocketCorsAuthenticator & operator= (QWebSocketCorsAuthenticator && other )
QWebSocketCorsAuthenticator & operator= (const QWebSocketCorsAuthenticator & other )

详细描述

QWebSocketCorsAuthenticator class provides an authenticator object for Cross Origin Requests (CORS).

QWebSocketCorsAuthenticator class is used in the originAuthenticationRequired() 信号。类提供手段把所需信息传递回 QWebSocketServer 。它为应用程序提供哪些来源 URL 被允许,哪些不被允许的细粒度控制。默认情况下,接受每个来源。为获得细粒度控制,应用程序连接 originAuthenticationRequired() 信号到槽。当来源 ( QWebSocketCorsAuthenticator::origin ()) 被接受,它调用 QWebSocketCorsAuthenticator::setAllowed (true)

注意: 当凭借非浏览器客户端访问服务器时,校验来源没有多大意义,因为这种客户端可以设置它喜欢的任何来源的 Header 头。若是浏览器客户端,服务器应该校验来源的有效性。

另请参阅 WebSocket Security Considerations and QWebSocketServer .

成员函数文档编制

QWebSocketCorsAuthenticator:: QWebSocketCorsAuthenticator (const QString & origin )

构造新 QCorsAuthencator 对象采用给定 origin .

注意: 默认情况下, allowed () 返回 true。这意味着默认接受每个来源。

QWebSocketCorsAuthenticator:: QWebSocketCorsAuthenticator (const QWebSocketCorsAuthenticator & other )

构造副本为 other .

QWebSocketCorsAuthenticator:: QWebSocketCorsAuthenticator ( QWebSocketCorsAuthenticator && other )

移动构造 QWebSocketCorsAuthenticator , making it point at the same object other 所指向的。

QWebSocketCorsAuthenticator:: ~QWebSocketCorsAuthenticator ()

销毁对象。

bool QWebSocketCorsAuthenticator:: allowed () const

返回 true 若来源是允许的,否则返回 false。

注意: 默认情况下,所有来源均被接受。

另请参阅 setAllowed ().

QString QWebSocketCorsAuthenticator:: origin () const

返回此身份验证器正在处理的有关来源。

void QWebSocketCorsAuthenticator:: setAllowed ( bool allowed )

允许或禁止来源。设置 allowed 为 true,将接受给定来源的连接请求。

设置 allowed 为 false,将拒绝连接请求。

注意: 默认情况下,所有来源均被接受。

另请参阅 allowed ().

void QWebSocketCorsAuthenticator:: swap ( QWebSocketCorsAuthenticator & other )

交换 other 与此身份验证器。

此操作非常快且从不失败。

QWebSocketCorsAuthenticator &QWebSocketCorsAuthenticator:: operator= ( QWebSocketCorsAuthenticator && other )

移动赋值 other 到此实例。

QWebSocketCorsAuthenticator &QWebSocketCorsAuthenticator:: operator= (const QWebSocketCorsAuthenticator & other )

赋值 other 到此身份验证器对象。