WsfXIO_Query Class Reference

#include <WsfXIO_Query.hpp>

Collaboration diagram for WsfXIO_Query:

Public Member Functions
	WsfXIO_Query (WsfXIO_Connection *aConnectionPtr)
virtual	~WsfXIO_Query ()
void	SetTimeout (double aTimeoutSeconds)
const GenUniqueId &	GetQueryId () const
virtual void	HandleResolution (WsfXIO_QueryResolutionPkt &aPkt)
virtual void	Complete ()
WsfXIO_Connection *	GetConnection () const
	Returns the connection to the requested application.
wsf::xio::QueryResult	GetResult () const
	Returns the result of the query.

Public Attributes
UtCallbackListN< void(WsfXIO_Query *)>	OnComplete
	Callback list invoked when the query is completed.

Protected Member Functions
virtual void	HandleDisconnect (WsfXIO_Connection *aConnectionPtr)
virtual void	HandleTimeout ()

Protected Attributes
wsf::xio::QueryResult	mResult
GenUniqueId	mId
WsfXIO_Connection *	mConnectionPtr
UtCallbackHolder	mCallbacks

Detailed Description

Represents a request for information from another application. The actual message containing the request parameters must be sent separately.

Constructor & Destructor Documentation

WsfXIO_Query()

WsfXIO_Query::WsfXIO_Query

(

WsfXIO_Connection *

aConnectionPtr

)

Initializes a query to an application

Parameters

aConnectionPtr

A reliable connection to the application which is the destination

References WsfXIO_Connection::IsReliable(), mCallbacks, mConnectionPtr, and mResult.

~WsfXIO_Query()

WsfXIO_Query::~WsfXIO_Query ( )

virtual

References wsf::xio::cQUERY_NOT_COMPLETE, mConnectionPtr, and mResult.

Member Function Documentation

Complete()

void WsfXIO_Query::Complete ( )

virtual

References mConnectionPtr, and OnComplete.

Referenced by HandleDisconnect(), HandleResolution(), and HandleTimeout().

GetConnection()

WsfXIO_Connection * WsfXIO_Query::GetConnection ( ) const

inline

Returns the connection to the requested application.

References mConnectionPtr.

GetQueryId()

const GenUniqueId & WsfXIO_Query::GetQueryId ( ) const

inline

References mId.

Referenced by WsfXIO_QueryManager::AddQuery(), and WsfXIO_QueryManager::RemoveQuery().

GetResult()

wsf::xio::QueryResult WsfXIO_Query::GetResult ( ) const

inline

Returns the result of the query.

References mResult.

Referenced by WsfXIO_QuerySet::AddQuery(), and WsfXIO_QuerySet::GetSuccessfulQueries().

HandleDisconnect()

void WsfXIO_Query::HandleDisconnect ( WsfXIO_Connection * aConnectionPtr )

protectedvirtual

References Complete(), wsf::xio::cQUERY_DISCONNECTED, wsf::xio::cQUERY_NOT_COMPLETE, mConnectionPtr, and mResult.

HandleResolution()

void WsfXIO_Query::HandleResolution ( WsfXIO_QueryResolutionPkt & aPkt )

virtual

References Complete(), mResult, and WsfXIO_QueryResolutionPkt::mResult.

HandleTimeout()

void WsfXIO_Query::HandleTimeout ( )

protectedvirtual

References Complete(), wsf::xio::cQUERY_TIMED_OUT, and mResult.

SetTimeout()

void WsfXIO_Query::SetTimeout

(

double

aTimeoutSeconds

)

Sets the query timeout. If they query has not been resolved prior to this time, OnComplete will be invoked

References mCallbacks, and mConnectionPtr.

Member Data Documentation

mCallbacks

UtCallbackHolder WsfXIO_Query::mCallbacks

protected

Referenced by SetTimeout(), and WsfXIO_Query().

mConnectionPtr

WsfXIO_Connection* WsfXIO_Query::mConnectionPtr

protected

Referenced by Complete(), GetConnection(), HandleDisconnect(), SetTimeout(), WsfXIO_Query(), and ~WsfXIO_Query().

mId

GenUniqueId WsfXIO_Query::mId

protected

Referenced by GetQueryId().

mResult

wsf::xio::QueryResult WsfXIO_Query::mResult

protected

Referenced by GetResult(), HandleDisconnect(), HandleResolution(), HandleTimeout(), WsfXIO_Query(), and ~WsfXIO_Query().

OnComplete

UtCallbackListN<void(WsfXIO_Query*)> WsfXIO_Query::OnComplete

Callback list invoked when the query is completed.

Referenced by WsfXIO_QuerySet::AddQuery(), and Complete().

---

The documentation for this class was generated from the following files:

• WsfXIO_Query.hpp
• WsfXIO_Query.cpp