[ROOT] --> C++Client

class PCREGateway
    inherited from public PCREService

The PCREGateway class provides connection manangement for the PCREGateway.

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

Version:
2.4.0

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

Friends:
 friend class PCREClient ;
 friend class PCREAppClient ;

Constructors Index

PCREGateway
Request a PCREGateway service on a given host and server.
PCREGateway
Request a PCREGateway service on a given host and unnamed server.
PCREGateway
Request a PCREGateway service on unnamed host and server.

Methods Index

Connect
Connect this gateway to the host that was specified, using the supplied arguments, if any.
Disconnect
Terminate the connection to this server.
getAPI
getForward
Get the value of the request forwarding property.
getHost
Retrieve the hostname on which the gateway is running.
getName
Retrieve the name of the gateway, this defaults to a psuedo-random number, unless it has been explicitly set.
getSecurity
Get the security property of this gateway.
getService
Retrieve the name of this service.
getWait
Get the wait property of this gateway.
RequestServer
Request a server to be opened on the gateway host.
RequestServer
Request a server to be opened on the gateway host.
setForward
Set the value of the request forwarding property.
setHost
Set the hostname on which the gateway is to run.
setName
Set the name of the gateway, this defaults to a psuedo-random number, unless it has been explicitly set.
setSecurity
Set the security property of this gateway, this cannot be done after the gateway has connected.
setWait
Set the wait property of this gateway.


Constructors

PCREGateway

 PCREGateway ( const char* host , const char* name ) ;

Request a PCREGateway service on a given host and server.

Parameters:
host The host machine
server The server name.

PCREGateway

 PCREGateway ( const char * host ) ;

Request a PCREGateway service on a given host and unnamed server.

Parameters:
host The host machine.

PCREGateway

 PCREGateway ( ) ;

Request a PCREGateway service on unnamed host and server.


Methods

getName

 const char * getName ( ) ;

Retrieve the name of the gateway, this defaults to a psuedo-random number, unless it has been explicitly set.

Return:
The name of the gateway.

setName

 void setName ( const char * name ) ;

Set the name of the gateway. The gateway name defaults to a psuedo-random number unless the name has been explicitly set.

Parameters:
name The name of the gateway.

getHost

 const char * getHost ( ) ;

Retrieve the name of the host machine on which the gateway is running.

Return:
The hostname of the machine running the gateway.

setHost

 void setHost ( const char * address ) ;

Set the hostname of the machine on which the gateway is to run.

Parameters:
address The host machine on whcih the gateway is to run.

getService

 const char * getService ( ) ;

Retrieve the name of this service.

Return:
The name of this service.

getForward

 BOOL getForward ( ) ;

Get the value of the request forwarding property.

Return:
The current value of the request forwarding property.

setForward

 void setForward ( BOOL value ) ;

Set the value of the request forwarding property.

Parameters:
value The new value of the request-forwarding property.

getWait

 int getWait ( ) ;

Get the wait property of this gateway.

Return:
The current value of the wait property.

setWait

 void setWait ( int value ) ;

Set the wait property of this gateway.

Parameters:
value The new value of the wait property.

getSecurity

 PCRESecurity * getSecurity ( ) ;

Get the security property of this gateway.

Return:
The value of the security property.

setSecurity

 void setSecurity ( PCRESecurity * value ) ;

Set the security property of this gateway, this cannot be done after the gateway has connected.

Parameters:
value The new value of the security property.

getAPI

 const GatewayServer_ptr getAPI ( ) ;

Connect

 void Connect ( ) ;

Connect this gateway to the host that was specified, using the supplied arguments, if any.

Disconnect

 void Disconnect ( ) ;

Terminate the connection to this server.

RequestServer

 void RequestServer ( PCREServer * server ) ;

Request a server to be opened on the gateway host.

Parameters:
server The server that is being requested.

RequestServer

 void RequestServer ( ) ;

Request a server to be opened on the gateway host.


Copyright (c) 2000 Dynalivery Corp.