Skip Headers

Oracle® C++ Call Interface Programmer's Guide
10g Release 1 (10.1)

Part Number B10778-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

Agent Class

The Agent class represents an agent in the Advanced Queuing context.

Table 10-2 Summary of Agent Methods

Method Summary
Agent()
Agent class constructor.
getAddress()
Return the address of the Agent.
getName()
Return the name of the Agent.
getProtocol()
Return the protocol of the Agent.
isNull()
Test whether the Agent object is NULL.
setAddress()
Set address of the Agent object.
setName()
Set name of the Agent object.
setNull()
Set Agent object to NULL.
setProtocol()
Set protocol of the Agent object.


Agent()

Agent class constructor.

Syntax Description
Agent(
   Environment *env);
Creates an Agent object initialized to its default values.
Agent(
   Environment *env,
   const string& name,
   const string& address,
   unsigned int protocol = 0);
Creates an Agent object with specified Agent's name, address, and protocol.

Parameter Description
env
Environment
name
Name
address
Address
protocol
Protocol


getAddress()

Returns a string containing Agent's address.


Syntax
string getAddress() const;


getName()

Returns a string containing Agent's name.


Syntax
string getName() const;


getProtocol()

Returns a numeric code representing Agent's protocol.


Syntax
unsigned int getProtocol();


isNull()

Tests whether the Agent object is NULL. If the Agent object is NULL, then TRUE is returned; otherwise, FALSE is returned.


Syntax
bool isNull();


setAddress()

Set the address of the Agent object.


Syntax
void setAddress(
   const string& address);

Parameter Description
address
The name of the Agent object.


setName()

Set the name of the Agent object.


Syntax
void setName(
   const string& name);

Parameter Description
name
The name of the Agent object.


setNull()

Sets the Agent object to NULL. Unless operating in an inner scope, this call should be made before terminating the Connection used to create this Agent.


Syntax
void setNull();


setProtocol()

Set the protocol of the Agent object.


Syntax
void setProtocol(
   unsigned int protocol = 0);
Parameter Description
protocol
The protocol of the Agent object.