| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions
oracle::occi::aq::Consumer Class Reference

`#include <occiAQ.h>`

List of all members.

## Public Types

enum | DequeueMode { DEQ_BROWSE = OCI_DEQ_BROWSE, DEQ_LOCKED = OCI_DEQ_LOCKED, DEQ_REMOVE = OCI_DEQ_REMOVE, DEQ_REMOVE_NODATA = OCI_DEQ_REMOVE_NODATA }
enum | Navigation { DEQ_FIRST_MSG = OCI_DEQ_FIRST_MSG, DEQ_NEXT_TRANSACTION = OCI_DEQ_NEXT_TRANSACTION, DEQ_NEXT_MSG = OCI_DEQ_NEXT_MSG }
enum | Visibility { DEQ_IMMEDIATE = OCI_DEQ_IMMEDIATE, DEQ_ON_COMMIT = OCI_DEQ_ON_COMMIT }
enum | { DEQ_WAIT_FOREVER = OCI_DEQ_WAIT_FOREVER, DEQ_NO_WAIT = OCI_DEQ_NO_WAIT }

## Public Member Functions

| Consumer (const Connection *conn)
| Consumer (const Connection *conn, const Agent &agent)
| Consumer (const Connection *conn, const OCCI_STD_NAMESPACE::string &queue)
| Consumer (const Consumer &con)
| ~Consumer ()
void | operator= (const Consumer &con)
void | setAgent (const Agent &agent)
void | setConsumerName (const OCCI_STD_NAMESPACE::string &name)
OCCI_STD_NAMESPACE::string | getConsumerName () const
void | setCorrelationId (const OCCI_STD_NAMESPACE::string &cor_id)
OCCI_STD_NAMESPACE::string | getCorrelationId () const
void | setDequeueMode (DequeueMode mode)
DequeueMode | getDequeueMode () const
void | setMessageIdToDequeue (const Bytes &msgid)
Bytes | getMessageIdToDequeue () const
void | setPositionOfMessage (Navigation pos)
Navigation | getPositionOfMessage () const
void | setVisibility (Visibility option)
Visibility | getVisibility () const
void | setWaitTime (unsigned int wait)
unsigned int | getWaitTime () const
void | setQueueName (const OCCI_STD_NAMESPACE::string &queue)
OCCI_STD_NAMESPACE::string | getQueueName () const
void | setTransformation (const OCCI_STD_NAMESPACE::string &fName)
OCCI_STD_NAMESPACE::string | getTransformation () const
Message | receive (Message::PayloadType pType, const OCCI_STD_NAMESPACE::string &type="", const OCCI_STD_NAMESPACE::string &schema="")
void | setNull ()
bool | isNull () const

## Member Enumeration Documentation

anonymous enum

Enumerator:

  DEQ_WAIT_FOREVER |
  DEQ_NO_WAIT |

enum oracle::occi::aq::Consumer::DequeueMode

Enumerator:

  DEQ_BROWSE |
  DEQ_LOCKED |
  DEQ_REMOVE |
  DEQ_REMOVE_NODATA |

enum oracle::occi::aq::Consumer::Navigation

Enumerator:

  DEQ_FIRST_MSG |
  DEQ_NEXT_TRANSACTION |
  DEQ_NEXT_MSG |

enum oracle::occi::aq::Consumer::Visibility

Enumerator:

  DEQ_IMMEDIATE |
  DEQ_ON_COMMIT |

## Constructor & Destructor Documentation

oracle::occi::aq::Consumer::Consumer | ( | const Connection * | conn | ) |

oracle::occi::aq::Consumer::Consumer | ( | const Connection * | conn,
|  | const Agent & | agent
| ) |  |

oracle::occi::aq::Consumer::Consumer | ( | const Connection * | conn,
|  | const OCCI_STD_NAMESPACE::string & | queue
| ) |  |

oracle::occi::aq::Consumer::Consumer | ( | const Consumer & | con | ) |

oracle::occi::aq::Consumer::~Consumer | ( |  | ) |

## Member Function Documentation

OCCI_STD_NAMESPACE::string oracle::occi::aq::Consumer::getConsumerName | ( |  | ) | const

OCCI_STD_NAMESPACE::string oracle::occi::aq::Consumer::getCorrelationId | ( |  | ) | const

DequeueMode oracle::occi::aq::Consumer::getDequeueMode | ( |  | ) | const

Bytes oracle::occi::aq::Consumer::getMessageIdToDequeue | ( |  | ) | const

Navigation oracle::occi::aq::Consumer::getPositionOfMessage | ( |  | ) | const

OCCI_STD_NAMESPACE::string oracle::occi::aq::Consumer::getQueueName | ( |  | ) | const

OCCI_STD_NAMESPACE::string oracle::occi::aq::Consumer::getTransformation | ( |  | ) | const

Visibility oracle::occi::aq::Consumer::getVisibility | ( |  | ) | const

unsigned int oracle::occi::aq::Consumer::getWaitTime | ( |  | ) | const

bool oracle::occi::aq::Consumer::isNull | ( |  | ) | const

void oracle::occi::aq::Consumer::operator= | ( | const Consumer & | con | ) |

Message oracle::occi::aq::Consumer::receive | ( | Message::PayloadType | pType,
|  | const OCCI_STD_NAMESPACE::string & | type = `""`,
|  | const OCCI_STD_NAMESPACE::string & | schema = `""`
| ) |  |

void oracle::occi::aq::Consumer::setAgent | ( | const Agent & | agent | ) |

void oracle::occi::aq::Consumer::setConsumerName | ( | const OCCI_STD_NAMESPACE::string & | name | ) |

void oracle::occi::aq::Consumer::setCorrelationId | ( | const OCCI_STD_NAMESPACE::string & | cor_id | ) |

void oracle::occi::aq::Consumer::setDequeueMode | ( | DequeueMode | mode | ) |

void oracle::occi::aq::Consumer::setMessageIdToDequeue | ( | const Bytes & | msgid | ) |

void oracle::occi::aq::Consumer::setNull | ( |  | ) |

void oracle::occi::aq::Consumer::setPositionOfMessage | ( | Navigation | pos | ) |

void oracle::occi::aq::Consumer::setQueueName | ( | const OCCI_STD_NAMESPACE::string & | queue | ) |

void oracle::occi::aq::Consumer::setTransformation | ( | const OCCI_STD_NAMESPACE::string & | fName | ) |

void oracle::occi::aq::Consumer::setVisibility | ( | Visibility | option | ) |

void oracle::occi::aq::Consumer::setWaitTime | ( | unsigned int | wait | ) |

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/drivers/Oracle/OCI/include/occiAQ.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines