Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* @(#)mqsession.h 1.22 06/26/07
*/
#ifndef MQ_SESSION_H
#define MQ_SESSION_H
/*
* declarations of C interface for session
*/
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#include "mqtypes.h"
#include "mqcallback-types.h"
/**
* Closes the session. This closes all producers and consumers
* created from this session. This will force all threads associated
* with this session that are blocking in the library (e.g. a consumer
* calling MQReceiveMessageWait) to return.
*
* @param sessionHandle the handle to the session to close
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCloseSession(MQSessionHandle sessionHandle);
/**
* Creates a destination with the given name and type.
*
* @param sessionHandle the handle to the session for which to
* create the destination
* @param destinationName the name of the destination
* @param destinationType MQ_QUEUE_DESTINATION or MQ_TOPIC_DESTINATION
* @param destinationHandle the output handle of the newly created
* destination.
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateDestination(const MQSessionHandle sessionHandle,
ConstMQString destinationName,
MQDestinationType destinationType,
MQDestinationHandle * destinationHandle);
/**
* Creates a temporary destination of the given type.
*
* @param sessionHandle the handle to the session for which to
* create the temporary destination
* @param destinationType MQ_QUEUE_DESTINATION or MQ_TOPIC_DESTINATION
* @param destinationHandle the output handle of the newly created
* temporary destination.
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateTemporaryDestination(const MQSessionHandle sessionHandle,
MQDestinationType destinationType,
MQDestinationHandle * destinationHandle);
/**
* Creates a message producer with a specified destination.
*
* @param sessionHandle the handle to the session for which to
* create the message producer
* @param destinationHandle the destination to which the created producer
* will send messages
* @param producerHandle the output handle of the newly created
* producer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateMessageProducerForDestination(
const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
MQProducerHandle * producerHandle);
/**
* Creates a message producer with no specified destination.
*
* @param sessionHandle the handle to the session for which to
* create the message producer
* @param producerHandle the output handle of the newly created
* producer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateMessageProducer(const MQSessionHandle sessionHandle,
MQProducerHandle * producerHandle);
/**
* Creates a message consumer with the given properties for
* synchronous receiving.
*
* @param sessionHandle the handle to the session for which to
* create the message consumer
* @param destinationHandle the destination on which the consumer
* receives messages
* @param messageSelector the message selector
* @param noLocal MQ_TRUE iff the consumer should not receive
* messages sent by a producer on this connection
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString messageSelector,
MQBool noLocal,
MQConsumerHandle * consumerHandle);
/**
* Creates a shared non-durable subscription on the specified Topic
* destination with the given properties for synchronous receiving.
*
* @param sessionHandle the handle to the session for which to
* create the message consumer
* @param destinationHandle the destination on which the consumer
* receives messages
* @param subscriptionName the subscription name
* @param messageSelector the message selector
* @param noLocal if MQ_TRUE and the connection has client ID set,
* the subscription should not receive messages sent by a
* producer on a connection with the same client ID
* @param consumerHandle the output handle to the newly created
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateSharedMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString subscriptionName,
ConstMQString messageSelector,
MQBool noLocal,
MQConsumerHandle * consumerHandle);
/**
* Creates a durable message consumer with the given properties
* for synchronous receiving.
*
* @param sessionHandle the handle to the session for which to
* create the message consumer
* @param destinationHandle the destination on which the consumer
* receives messages
* @param durableName the name of the durable subscriber.
* @param messageSelector the messages selector
* @param noLocal if MQ_TRUE the consumer should not receive messages
* sent by a producer on a connection with the same client ID
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateDurableMessageConsumer(
const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString durableName,
ConstMQString messageSelector,
MQBool noLocal,
MQConsumerHandle * consumerHandle);
/**
* Creates a shared durable subscription on the specified Topic
* destination with the given properties for synchronous receiving.
*
* @param sessionHandle the handle to the session for which to
* create the message consumer
* @param destinationHandle the destination on which the consumer
* receives messages
* @param durableName the subscription name
* @param messageSelector the message selector
* @param noLocal if MQ_TRUE and the connection has client ID set,
* the subscription should not receive messages sent by a
* producer on a connection with the same client ID
* @param consumerHandle the output handle to the newly created
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateSharedDurableMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString durableName,
ConstMQString messageSelector,
MQBool noLocal,
MQConsumerHandle * consumerHandle);
/**
* Creates a message consumer for asynchronous receiving. The session
* that is represented by the sessionHandle must be created with
* MQ_SESSION_ASYNC_RECEIVE
*
* @param sessionHandle the handle to the session for which to
* create the message consumer.
* @param destinationHandle the destination on which the consumer
* receives messages
* @param messageSelector the messages selector
* @param noLocal MQ_TRUE iff the consumer should not receive
* messages sent by a producer on this connection
* @param messageListener the message listener callback function
* @param listenerCallbackData void * data pointer that to be
* passed to the message listener function when it is called
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateAsyncMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString messageSelector,
MQBool noLocal,
MQMessageListenerFunc messageListener,
void * listenerCallbackData,
MQConsumerHandle * consumerHandle);
/**
* Creates a shared non-durable subscription on the specified Topic
* destination for asynchronous receiving. The session that is
* represented by the sessionHandle must be created with
* MQ_SESSION_ASYNC_RECEIVE
*
* @param sessionHandle the handle to the session for which to
* create the message consumer.
* @param destinationHandle the destination on which the consumer
* receives messages
* @param subscriptionName the subscription name
* @param messageSelector the messages selector
* @param noLocal if MQ_TRUE and the connection has client ID set,
* the subscription should not receive messages sent by
* a producer on a connection that has the same client ID
* @param messageListener the message listener callback function
* @param listenerCallbackData void * data pointer that to be
* passed to the message listener function when it is called
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateAsyncSharedMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString subscriptionName,
ConstMQString messageSelector,
MQBool noLocal,
MQMessageListenerFunc messageListener,
void * listenerCallbackData,
MQConsumerHandle * consumerHandle);
/**
* Creates a durable message consumer for asynchronous receiving.
* The session that is represented by sessionHandle must be created
* with MQ_SESSION_ASYNC_RECEIVE
*
* @param sessionHandle the handle to the session for which to
* create the message consumer
* @param destinationHandle the destination on which the consumer
* receives messages
* @param durableName the name of the durable subscriber.
* @param messageSelector the message selector
* @param noLocal MQ_TRUE iff the consumer should not receive
* messages sent by a producer on this connection
* @param messageListener the mesage listener callback function
* @param listenerCallbackData void * data pointer that to be
* passed to the message listener function when it is called
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateAsyncDurableMessageConsumer(
const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString durableName,
ConstMQString messageSelector,
MQBool noLocal,
MQMessageListenerFunc messageListener,
void * listenerCallbackData,
MQConsumerHandle * consumerHandle);
/**
* Creates a shared durable subscription on the specified Topic
* destination for asynchronous receiving. The session that is
* represented by the sessionHandle must be created with
* MQ_SESSION_ASYNC_RECEIVE
*
* @param sessionHandle the handle to the session for which to
* create the message consumer.
* @param destinationHandle the destination on which the consumer
* receives messages
* @param durableName the durable name
* @param messageSelector the messages selector
* @param noLocal if MQ_TRUE and the connection has client ID set,
* the consumer should not receive messages sent by a
* producer on a connection that has the same client ID
* @param messageListener the message listener callback function
* @param listenerCallbackData void * data pointer that to be
* passed to the message listener function when it is called
* @param consumerHandle the output handle to the newly creaated
* consumer
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCreateAsyncSharedDurableMessageConsumer(const MQSessionHandle sessionHandle,
const MQDestinationHandle destinationHandle,
ConstMQString durableName,
ConstMQString messageSelector,
MQBool noLocal,
MQMessageListenerFunc messageListener,
void * listenerCallbackData,
MQConsumerHandle * consumerHandle);
/**
* Unsubscribes the durable message consumer with the given durable
* name. This deletes all messages at the broker that were being
* stored for this durable consumer. This function cannot be called
* if there is an active consumer with the specified durable name.
*
* @param sessionHandle the handle to the session to use to
* unsubscribe the durable consumer.
* @param durableName the name of the durable subscriber.
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQUnsubscribeDurableMessageConsumer(const MQSessionHandle sessionHandle,
ConstMQString const durableName);
/**
* Stops message delivery in this session, and restarts message
* delivery with the oldest unacknowledged message.
*
* All consumers deliver messages in a serial order. Acknowledging
* a received message automatically acknowledges all messages that
* have been delivered to the client.
*
* Restarting a session causes it to take the following actions:
* . Stop message delivery
* . Mark all messages that might have been delivered but not acknowledged
* as "redelivered"
* . Restart the delivery sequence including all unacknowledged messages
* that had been previously delivered. Redelivered messages do not have
* to be delivered in exactly their original delivery order.
*
* @param sessionHandle the handle to the session
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQRecoverSession(const MQSessionHandle sessionHandle);
/**
* Commits all messages done in this transaction
*
* @param sessionHandle the handle to the session
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQCommitSession(const MQSessionHandle sessionHandle);
/**
* Rolls back any messages done in this transaction
*
* @param sessionHandle the handle to the session
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQRollbackSession(const MQSessionHandle sessionHandle);
/**
* Get session acknowledge mode
*
* @param sessionHandle the handle to the session
* @param ackMode output parameter
* @return the status of the function call. Pass this value to
* MQStatusIsError to determine if the call was
* successful. */
EXPORTED_SYMBOL MQStatus
MQGetAcknowledgeMode(const MQSessionHandle sessionHandle, MQAckMode * ackMode);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* MQ_SESSION_H */
