lbmaux.h

Go to the documentation of this file.

/** \file lbmaux.h
        \brief Ultra Messaging (UM) Auxiliary Functions API
        \author David K. Ameiss - Informatica Corporation 
        \version $Id: //UMprod/REL_5_3_6/29West/lbm/src/auxx/lbm/lbmaux.h#2 $
        
        The Ultra Messaging (UM) Auxiliary Functions API Description. Included
        are types, constants, and functions related to the API. Contents are
        subject to change.

        All of the documentation and software included in this and any
        other Informatica Corporation Ultra Messaging Releases
        Copyright (C) Informatica Corporation. All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted only as covered by the terms of a
        valid software license agreement with Informatica Corporation.
        
        Copyright (C) 2006-2014, Informatica Corporation. All Rights Reserved.
        
        THE SOFTWARE IS PROVIDED "AS IS" AND INFORMATICA DISCLAIMS ALL WARRANTIES 
        EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF 
        NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
        PURPOSE.  INFORMATICA DOES NOT WARRANT THAT USE OF THE SOFTWARE WILL BE 
        UNINTERRUPTED OR ERROR-FREE.  INFORMATICA SHALL NOT, UNDER ANY CIRCUMSTANCES, BE 
        LIABLE TO LICENSEE FOR LOST PROFITS, CONSEQUENTIAL, INCIDENTAL, SPECIAL OR 
        INDIRECT DAMAGES ARISING OUT OF OR RELATED TO THIS AGREEMENT OR THE 
        TRANSACTIONS CONTEMPLATED HEREUNDER, EVEN IF INFORMATICA HAS BEEN APPRISED OF 
        THE LIKELIHOOD OF SUCH DAMAGES.
*/

#ifndef LBMAUX_H_INCLUDED
#define LBMAUX_H_INCLUDED

#include <stdlib.h>
#ifdef _WIN32
        #include <winsock2.h>
#endif
#include <lbm/lbm.h>

#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */

/*! \brief Create and initialize an lbm_context_t object,
                initialized with configuration options from a file.

        This function parses a configuration file,
        and creates an ::lbm_context_attr_t object with context-scope option values
        from the configuration file.
        It then calls lbm_context_create() with the attributes object.

        \sa lbm_context_create()
        \sa lbm_context_delete()

        \param Context A pointer to a pointer to an LBM context object.
                Will be filled in by this function to point to the newly created
                ::lbm_context_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_context_create_from_file(lbm_context_t * * Context,
                                                                                          const char * ConfigFile);

/*! \brief Set attributes values in an ::lbm_context_attr_t object from a
                configuration file.

        This function parses a configuration file,
        and applies context-scope option values to an ::lbm_context_attr_t object.

        \param Attributes A pointer to an initialized ::lbm_context_attr_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_context_attr_setopt_from_file(lbm_context_attr_t * Attributes,
                                                                                                   const char * ConfigFile);

/*! \brief Set attributes values in an ::lbm_src_topic_attr_t object from a
                configuration file.

        This function parses a configuration file,
        and applies source-scope option values to an ::lbm_src_topic_attr_t object.

        \param Attributes A pointer to an initialized ::lbm_src_topic_attr_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_src_topic_attr_setopt_from_file(lbm_src_topic_attr_t * Attributes,
                                                                                                         const char * ConfigFile);

/*! \brief Set attributes values in an ::lbm_rcv_topic_attr_t object from a
                configuration file.

        This function parses a configuration file,
        and applies receiver-scope option values to an ::lbm_rcv_topic_attr_t object.

        \param Attributes A pointer to an initialized ::lbm_rcv_topic_attr_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_rcv_topic_attr_setopt_from_file(lbm_rcv_topic_attr_t * Attributes,
                                                                                                         const char * ConfigFile);

/*! \brief Set attributes values in an ::lbm_wildcard_rcv_attr_t object from a
                configuration file.

        This function parses a configuration file,
        and applies wildcard-receiver-scope option values to an ::lbm_wildcard_rcv_attr_t object.

        \param Attributes A pointer to an initialized ::lbm_wildcard_rcv_attr_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_wildcard_rcv_attr_setopt_from_file(lbm_wildcard_rcv_attr_t * Attributes,
                                                                                                                const char * ConfigFile);

/*! \brief Set attributes values in an ::lbm_event_queue_attr_t object from a
                configuration file.

        This function parses a configuration file,
        and applies event-queue-scope option values to an ::lbm_event_queue_attr_t object.

        \param Attributes A pointer to an initialized ::lbm_event_queue_attr_t object.
        \param ConfigFile String containing the filename that contains the options
                to parse and set.
        \return 0 for Success and -1 for Failure.
*/
LBMExpDLL int lbmaux_event_queue_attr_setopt_from_file(lbm_event_queue_attr_t * Attributes,
                                                                                                                const char * ConfigFile);


#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif

---