PCREClient

[ROOT] --> C++Client

class PCREClient
inherited from PCRESynchronized

The PCREClient class provides a framework for the C/C++ client.

Author:: Copyright (c) 2000 Dynalivery Corp., All Rights Reserved.

Version:: 2.4.0

Source:: MobileApps\PCRE\CppClient\Include\client.h

PCREClient: Construct a client with given console and arguments.
~PCREClient: Destructor for the client.

CloseRetrieveJob: Close the retrieve job currently opened in the client.
Connect: Derived client classes must override to connect the appropriate set of services.
Connected: Test to see if the client is connected to the named service.
Disconnect: Derived client classes must override to disconnect the appropriate set of services.
GetAPI: Retrieve an API entry.
getHost: Get this clients host
getName: Get the name of this client.
getORB: Get the ORB
getRetrieveJob: Return the retrieve job currently opened in the client.
getRetrieveMode: Get the report retrieve-mode setting for the client.
GetService: Retrieve the named service from the PCRERegistry.
getThreadClient: Get the thread client instance.
getThreadConsole: Get the console used by this client.
OpenEngine: Acquire and optionally open a print-engine for this client.
OpenRetrieveJob: Open a retrieve joib for the named report. The function stores the original report name and returns a substitute which will be used on the remote report-server.
PrepareRetrieveJob: Prepare the retrieve job currently opened in the client.
PutAPI: Add an API to the API Registry.
RemoveAPI: Remove an API entry.
RemoveService: Remove the named service from the PCRERegistry.
RemoveService: Remove the service from the PCRERegistry.
setName: Set this client's name.
setRetrieveMode: Set the report retrieve-mode for the client.
setThreadConsole: Set the console passed in parameter.
StartRetrieveJob: Start the retrieve job currently opened in the client.
UseService: Add the service to the PCRERegistry.

PCREClient

 PCREClient ( PCREConsole * pConsole = NULL ,
                    int argc = 0 ,
                    char * const * argv = NULL ) ;

Construct a client with given console and arguments.

Parameters:

pConsole	The console to use when communicating with this client, defaults to NULL.
argc	The number of arguments that are being provided, defaults to zero.
argv	Any parameters to pass to the client, defaults to NULL.

PCREClient

 virtual ~ PCREClient ( ) ;

Destructor for the client.

getThreadClient

 static PCREClient * getThreadClient ( ) ;

Get the thread client instance.

Return:: The client object associated with this connection.

getThreadConsole

 static PCREConsole * getThreadConsole ( ) ;

Get the console used by this client.

Return:: The console used by this connection.

setThreadConsole

 static PCREConsole * setThreadConsole ( PCREConsole * console ) ;

Set the console passed in parameter.

Return:: The console initially used.

getHost

 static const char * getHost ( ) ;

Get this client's host.

Return:: The host from which this client is communicating

getName

 const char * getName ( ) ;

Get the name of this client.

Return:: The name property of this client.

setName

 void setName ( char * name ) ;

Set this client's name property.

Parameters:

name

The name to be associated with this client.

getRetrieveMode

 BOOL getRetrieveMode ( ) ;

Get the report retrieve-mode setting for the client.

Return:: TRUE if retrieve-mode is enabled; FALSE otherwise.

setRetrieveMode

 void setRetrieveMode ( BOOL value ) ;

Set the report retrieve-mode for the client.

getORB

 CORBA :: ORB_ptr getORB ( ) ;

Get the ORB.

Return:: The ORB (Object Request Broker) in use.

UseService

 void UseService ( PCREService * service ) ;

Add the service to the PCRERegistry.

Parameters:

service

The service to use.

GetService

 PCREService * GetService ( const char * name ) ;

Retrieve the named PCRE service from the PCRERegistry.

Parameters:

name

The name of the PCRE service to retrieve.

Return:: The PCRE service object.

RemoveService

 void RemoveService ( const char * name ) ;

Remove the named PCRE service from the PCRERegistry.

Parameters:

name

The name of the PCRE service to remove.

RemoveService

 void RemoveService ( PCREService * service ) ;

Remove the PCRE service from the PCRERegistry.

Parameters:

name

The name of the PCRE service to remove.

PutAPI

 void PutAPI ( const char * name ,
                     CORBA :: Object_ptr api ) ;

Add an API to the API Registry.

Parameters:

name	The name of the API.
api	The CORBA api object to use.

GetAPI

 CORBA :: Object_ptr GetAPI ( const char * name ) ;

Retrieve an API entry.

Parameters:

name

The name of the API to retrieve.

Return:: A CORBA API object.

RemoveAPI

 void RemoveAPI ( const char * name ) ;

Remove an API entry.

Parameters:

name

The name of the API to remove.

Connect

 virtual void Connect ( BOOL useLoadBalancer = FALSE ) = 0 ;

Derived client classes must override to connect the appropriate set of services.

Disconnect

 virtual void Disconnect ( ) = 0 ;

Derived client classes must override to disconnect the appropriate set of services.

Connected

 BOOL Connected ( const char * name ) ;

Test to see if the client is connected to the named service.

Parameters:

name

The name of the service to test.

Return:: True if connected, false otherwise.

OpenEngine

 PCREEngine * OpenEngine ( const BOOL open = TRUE ) ;

Acquire and optionally open a print-engine for this client.

Parameters:

open

If true, open the print-engine on the server.

OpenRetrieveJob

 char * OpenRetrieveJob ( const char * reportName ) ;

Open a retrieve joib for the named report. The function stores the original report name and returns a substitute which will be used on the remote report-server.

Parameters:

reportName

The local path-name for the report.

Return:: The remote path-name for the report.

getRetrieveJob

 PCRERetrieveJob * getRetrieveJob ( ) ;

Return the retrieve job currently opened in the client.

Return:: A pointer to the retrieve job, or NULL.

PrepareRetrieveJob

 void PrepareRetrieveJob ( ) ;

Prepare the retrieve job currently opened in the client.

StartRetrieveJob

 void StartRetrieveJob ( ) ;

Start the retrieve job currently opened in the client.

CloseRetrieveJob

 void CloseRetrieveJob ( ) ;

Close the retrieve job currently opened in the client.