CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Slots | Signals | Public Member Functions | Protected Attributes | List of all members
ctkEventBus::ctkNetworkConnectorQXMLRPC Class Reference

#include <Plugins/org.commontk.eventbus/ctkNetworkConnectorQXMLRPC.h>

Inheritance diagram for ctkEventBus::ctkNetworkConnectorQXMLRPC:
Inheritance graph
[legend]
Collaboration diagram for ctkEventBus::ctkNetworkConnectorQXMLRPC:
Collaboration graph
[legend]

Public Slots

void registerServerMethod (mafRegisterMethodsMap registerMethodsList)
 register methods on the server More...
 
void send (const QString event_id, ctkEventArgumentsList *argList)
 Allow to send a network request. More...
 

Signals

void registerMethodsServer (mafRegisterMethodsMap registerMethodsList)
 signal for the registration of the functions with parameters More...
 
- Signals inherited from ctkEventBus::ctkNetworkConnector
void remoteCommunication (const QString event_id, ctkEventArgumentsList *argList)
 signal for send a message to through network More...
 

Public Member Functions

ctkNetworkConnectorclone ()
 retrieve an instance of the object More...
 
void createClient (const QString hostName, const unsigned int port)
 create the unique instance of the client. More...
 
void createServer (const unsigned int port)
 create the unique instance of the server. More...
 
 ctkNetworkConnectorQXMLRPC ()
 object constructor. More...
 
void initializeForEventBus ()
 register all the signals and slots More...
 
void startListen ()
 Start the server. More...
 
 ~ctkNetworkConnectorQXMLRPC ()
 object destructor. More...
 
- Public Member Functions inherited from ctkEventBus::ctkNetworkConnector
 ctkNetworkConnector ()
 object constructor. More...
 
QString protocol ()
 retrieve the protocol type of the connector More...
 
virtual void send (const QString event_id, ctkEventArgumentsList *argList)=0
 Allow to send a network request. More...
 

Protected Attributes

xmlrpc::Client * m_Client
 xml-rpc client provided by qxmlrpc library More...
 
xmlrpc::Server * m_Server
 xml-rpc server provided by qxmlrpc library More...
 
- Protected Attributes inherited from ctkEventBus::ctkNetworkConnector
QString m_Protocol
 define the protocol of the connector (xmlrpc, soap, etc...) More...
 

Additional Inherited Members

- Properties inherited from ctkEventBus::ctkNetworkConnector
QString protocol
 

Detailed Description

Class name: ctkNetworkConnectorQXMLRPC This class is the implementation class for client/server objects that works over network with xml-rpc protocol. The server side part also create a new ID named REGISTER_SERVER_METHODS_XXX (where the XXX is the port on which run the server) that allows you to register your own remote callbacks. The library used is qxmlrpc.

Definition at line 31 of file ctkNetworkConnectorQXMLRPC.h.

Constructor & Destructor Documentation

◆ ctkNetworkConnectorQXMLRPC()

ctkEventBus::ctkNetworkConnectorQXMLRPC::ctkNetworkConnectorQXMLRPC ( )

object constructor.

◆ ~ctkNetworkConnectorQXMLRPC()

ctkEventBus::ctkNetworkConnectorQXMLRPC::~ctkNetworkConnectorQXMLRPC ( )

object destructor.

Member Function Documentation

◆ clone()

ctkNetworkConnector* ctkEventBus::ctkNetworkConnectorQXMLRPC::clone ( )
virtual

retrieve an instance of the object

Implements ctkEventBus::ctkNetworkConnector.

◆ createClient()

void ctkEventBus::ctkNetworkConnectorQXMLRPC::createClient ( const QString  hostName,
const unsigned int  port 
)
virtual

create the unique instance of the client.

Implements ctkEventBus::ctkNetworkConnector.

◆ createServer()

void ctkEventBus::ctkNetworkConnectorQXMLRPC::createServer ( const unsigned int  port)
virtual

create the unique instance of the server.

Implements ctkEventBus::ctkNetworkConnector.

◆ initializeForEventBus()

void ctkEventBus::ctkNetworkConnectorQXMLRPC::initializeForEventBus ( )
virtual

register all the signals and slots

Implements ctkEventBus::ctkNetworkConnector.

◆ registerMethodsServer

void ctkEventBus::ctkNetworkConnectorQXMLRPC::registerMethodsServer ( mafRegisterMethodsMap  registerMethodsList)
signal

signal for the registration of the functions with parameters

◆ registerServerMethod

void ctkEventBus::ctkNetworkConnectorQXMLRPC::registerServerMethod ( mafRegisterMethodsMap  registerMethodsList)
slot

register methods on the server

◆ send

void ctkEventBus::ctkNetworkConnectorQXMLRPC::send ( const QString  event_id,
ctkEventArgumentsList argList 
)
slot

Allow to send a network request.

Contains the conversion between maf datatypes and qxmlrpc datatype based both on QVariant.

◆ startListen()

void ctkEventBus::ctkNetworkConnectorQXMLRPC::startListen ( )
virtual

Start the server.

Implements ctkEventBus::ctkNetworkConnector.

Member Data Documentation

◆ m_Client

xmlrpc::Client* ctkEventBus::ctkNetworkConnectorQXMLRPC::m_Client
protected

xml-rpc client provided by qxmlrpc library

Definition at line 80 of file ctkNetworkConnectorQXMLRPC.h.

◆ m_Server

xmlrpc::Server* ctkEventBus::ctkNetworkConnectorQXMLRPC::m_Server
protected

xml-rpc server provided by qxmlrpc library

Definition at line 81 of file ctkNetworkConnectorQXMLRPC.h.


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