Skip Headers
Oracle® C++ Call Interface Programmer's Guide,
11g Release 2 (11.2)

Part Number E10764-02
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
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub
LNCPP1025

Agent Class

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

LNCPP20511Table 13-3 Summary of Agent Methods

Method Summary

Agent()

Agent class constructor.

getAddress()

Returns the address of the Agent.

getName()

Returns the name of the Agent.

getProtocol()

Returns the protocol of the Agent.

isNull()

Tests whether the Agent object is NULL.

operator=()

Assignment operator for Agent.

setAddress()

Sets address of the Agent object.

setName()

Sets name of the Agent object.

setNull()

Sets Agent object to NULL.

setProtocol()

Sets protocol of the Agent object.


LNCPP20512

Agent()

Agent class constructor.

Syntax Description
Agent(
   const Environment *env);
Creates an Agent object initialized to its default values.
Agent(
   const Agent& agent); 
Copy constructor.
Agent(
   const 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
agent
Original agent
address
Address
protocol
Protocol

LNCPP20513

getAddress()

Returns a string containing Agent's address.

LNCPP20514Syntax

string getAddress() const;
LNCPP20515

getName()

Returns a string containing Agent's name.

LNCPP20516Syntax

string getName() const;
LNCPP20517

getProtocol()

Returns a numeric code representing Agent's protocol.

LNCPP20518Syntax

unsigned int getProtocol() const;
LNCPP20519

isNull()

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

LNCPP20520Syntax

bool isNull() const;
LNCPP20521

operator=()

Assignment operator for Agent class.

LNCPP20522Syntax

void operator=(
const Agent& agent);
Parameter Description
agent
The original Agent object.

LNCPP20523

setAddress()

Sets the address of the Agent object.

LNCPP20524Syntax

void setAddress(
   const string& addr);
Parameter Description
addr
The name of the Agent object.

LNCPP20525

setName()

Sets the name of the Agent object.

LNCPP20526Syntax

void setName(
   const string& name);
Parameter Description
name
The name of the Agent object.

LNCPP20527

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.

LNCPP20528Syntax

void setNull();
LNCPP20529

setProtocol()

Sets the protocol of the Agent object.

LNCPP20530Syntax

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

Reader Comment

   

Comments, corrections, and suggestions are forwarded to authors every week. By submitting, you confirm you agree to the terms and conditions. Use the OTN forums for product questions. For support or consulting, file a service request through My Oracle Support.

Hide Navigation

Quick Lookup

Database Library · Master Index · Master Glossary · Book List · Data Dictionary · SQL Keywords · Initialization Parameters · Advanced Search · Error Messages

Main Categories

This Page

This Document

New and changed documents:
RSS Feed HTML RSS Feed PDF