Content starts here JmsConsumer.h File Reference
Skip navigation.
Main Page  |  Data Structures  |  File List  |  Data Fields  |  Globals

JmsConsumer.h File Reference

Describes a JmsConsumer handle. More...

#include <JmsCommon.h>
#include <JmsMessage.h>
#include <JmsTypes.h>

Go to the source code of this file.


Typedefs

typedef JmsConsumer JmsConsumer

Functions

int JMSENTRY JmsConsumerGetSelector (JmsConsumer *consumer, JmsString *selector, JMS64I flags)
int JMSENTRY JmsConsumerGetMessageListener (JmsConsumer *consumer, void(**listener)(JmsMessage *, void *, JMS64I), void **argument, JMS64I flags)
int JMSENTRY JmsConsumerSetMessageListener (JmsConsumer *consumer, void(*listener)(JmsMessage *, void *, JMS64I), void *argument, JMS64I flags)
int JMSENTRY JmsConsumerReceive (JmsConsumer *consumer, JMS64I timeout, JmsMessage **message, JMS64I flags)
int JMSENTRY JmsConsumerClose (JmsConsumer *consumer, JMS64I flags)

Detailed Description

Describes a JmsConsumer handle.

This file describes the functions that can be performed on a JmsConsumer handle A JmsConsumer handle corresponds to javax.jms.MessageConsumer

Author:
Copyright (c) 2002, BEA Systems, Inc.

Typedef Documentation

typedef struct JmsConsumer JmsConsumer
 

A consumer handle that represents the class javax.jms.MessageConsumer

Function Documentation

int JMSENTRY JmsConsumerClose (  JmsConsumer *    consumer,
JMS64I    flags
) 
 

Closes the message consumer.

Since a provider may allocate some resources on behalf of a consumer handle outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

This call blocks until a receive or message listener in progress has completed. A blocked message consumer receive call returns null when this message consumer is closed.

Parameters:
consumer  Must be a valid consumer handle. May not be NULL
flags  Reserved for future use. Must be zero
Returns:
  • JMS_NO_ERROR
  • JMS_GOT_EXCEPTION
  • JMS_INPUT_PARAM_ERROR
  • JMS_MALLOC_ERROR
  • JMS_JVM_ERROR
  • JMS_NEED_SPACE

int JMSENTRY JmsConsumerGetMessageListener (  JmsConsumer *    consumer,
void(**    listener)(JmsMessage *, void *, JMS64I),
void **    argument,
JMS64I    flags
) 
 

Gets a the message listener function associated with this consumer

Parameters:
consumer  Must be a valid connection handle. May not be NULL
listener  May not be NULL. On success *listener will contain the message listener function
argument  May not be NULL. On success *argument will contain the application supplied argument used for this consumer
flags  Reserved for future use. Must be zero
Returns:
  • JMS_NO_ERROR
  • JMS_GOT_EXCEPTION
  • JMS_INPUT_PARAM_ERROR
  • JMS_MALLOC_ERROR
  • JMS_JVM_ERROR

int JMSENTRY JmsConsumerGetSelector (  JmsConsumer *    consumer,
JmsString *    selector,
JMS64I    flags
) 
 

Gets the selector associated with a JmsConsumer

Parameters:
consumer  Must be a valid consumer handle. May not be NULL
selector  May not be NULL
flags  Reserved for future use. Must be zero
Returns:
  • JMS_NO_ERROR
  • JMS_GOT_EXCEPTION
  • JMS_INPUT_PARAM_ERROR
  • JMS_MALLOC_ERROR
  • JMS_JVM_ERROR
  • JMS_NEED_SPACE

int JMSENTRY JmsConsumerReceive (  JmsConsumer *    consumer,
JMS64I    timeout,
JmsMessage **    message,
JMS64I    flags
) 
 

Gets a message for this consumer

Parameters:
consumer  Must be a valid consumer handle. May not be NULL
timeout  The time in milliseconds to wait for a message
message  May not be NULL. On success *message will contain a valid message handle. It is the responsibility of the caller of this function to destroy the message returned
flags  Reserved for future use. Must be zero
Returns:
  • JMS_NO_ERROR
  • JMS_GOT_EXCEPTION
  • JMS_INPUT_PARAM_ERROR
  • JMS_MALLOC_ERROR
  • JMS_JVM_ERROR
  • JMS_NEED_SPACE

int JMSENTRY JmsConsumerSetMessageListener (  JmsConsumer *    consumer,
void(*    listener)(JmsMessage *, void *, JMS64I),
void *    argument,
JMS64I    flags
) 
 

Sets a message listener function associated with this consumer The message passed into the listener function is destroyed by the system after the listener function returns. Hence the message should not be freed by the listener function and should not be referenced after the listener function returns

Parameters:
consumer  Must be a valid consumer handle. May not be NULL
listener  The function that should be called in the event a message arrives for this consumer. The message passed into the function will normally be freed by the system when the function returns (see flags). The second parameter will be the argument passed to this function.
argument  An optional argument that can be passed to this message listener function when called by the system. This argument can be used for any purpose by the application.
flags  JMS_APPLICATION_MUST_FREE_HANDLE should be set if the message handle given to the listener function should not be freed by the system when the function returns. The flags value (plus the JMS_CALLED_FROM_JMS flag) will be passed to the listener function as its flags input parameter on every invokation.
Returns:
  • JMS_NO_ERROR
  • JMS_GOT_EXCEPTION
  • JMS_INPUT_PARAM_ERROR
  • JMS_MALLOC_ERROR
  • JMS_JVM_ERROR
Contact Oracle    Legal Notices    Copyright 1996,2010. Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server JMS C API Reference
11g Release 1 (10.3.4)

Part Number E13942-03

Generated by doxygen 1.2.18