~drizzle-trunk/drizzle/development : contents of libdrizzle/conn

~drizzle-trunk/drizzle/development : (revision 2482)

/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 * Drizzle Client & Protocol Library
 *
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *
 *     * The names of its contributors may not be used to endorse or
 * promote products derived from this software without specific prior
 * written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#pragma once

/**
 * @file
 * @brief Local Connection Declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup drizzle_con_local Local Connection Declarations
 * @ingroup drizzle_con
 * @{
 */

/**
 * Clear address info, freeing structs if needed.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 */
DRIZZLE_LOCAL
void drizzle_con_reset_addrinfo(drizzle_con_st *con);
 
/**
 * Check if state stack is empty.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @return True if empty, false if something is on the stack.
 */
static inline bool drizzle_state_none(drizzle_con_st *con)
{
  if (con == NULL)
  {
    return false;
  }

  return con->state_current == 0;
}

/**
 * Push a function onto the stack.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 * @param[in] function Function to push.
 */
static inline void drizzle_state_push(drizzle_con_st *con,
                                      drizzle_state_fn *function)
{
  /* The maximum stack depth can be determined at compile time, so bump this
     constant if needed to avoid the dynamic memory management. */
  assert(con->state_current < DRIZZLE_STATE_STACK_SIZE);
  con->state_stack[con->state_current]= function;
  con->state_current++;
}

/**
 * Pop a function off of the stack.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 */
static inline void drizzle_state_pop(drizzle_con_st *con)
{
  con->state_current--;
}

/**
 * Reset the stack so it is empty.
 *
 * @param[in] con Connection structure previously initialized with
 *  drizzle_con_create(), drizzle_con_clone(), or related functions.
 */
static inline void drizzle_state_reset(drizzle_con_st *con)
{
  con->state_current= 0;
}

/** @} */

#ifdef __cplusplus
}
#endif

2472.1.2 by Brian Aker Null safety fix for libdrizzle	1	/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2472.1.2 by Brian Aker Null safety fix for libdrizzle	2	*
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	3	* Drizzle Client & Protocol Library
	4	*
	5	* Copyright (C) 2008 Eric Day (eday@oddments.org)
	6	* All rights reserved.
	7	*
1971.2.1 by kalebral at gmail update files that did not have license or had incorrect license structure	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions are
	10	* met:
	11	*
	12	* * Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	*
	15	* * Redistributions in binary form must reproduce the above
	16	* copyright notice, this list of conditions and the following disclaimer
	17	* in the documentation and/or other materials provided with the
	18	* distribution.
	19	*
	20	* * The names of its contributors may not be used to endorse or
	21	* promote products derived from this software without specific prior
	22	* written permission.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	25	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	26	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	27	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	28	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	29	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	30	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	31	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	32	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	33	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	34	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	35	*
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	36	*/
	37
2449.1.4 by Brian Aker Complete update of libdrizzle	38	#pragma once
2449.1.4 by Brian Aker Complete update of libdrizzle	39
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	40	/**
	41	* @file
	42	* @brief Local Connection Declarations
	43	*/
	44
	45	#ifdef __cplusplus
	46	extern "C" {
	47	#endif
	48
	49	/**
	50	* @addtogroup drizzle_con_local Local Connection Declarations
	51	* @ingroup drizzle_con
	52	* @{
	53	*/
	54
	55	/**
	56	* Clear address info, freeing structs if needed.
	57	*
	58	* @param[in] con Connection structure previously initialized with
	59	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	60	*/
	61	DRIZZLE_LOCAL
	62	void drizzle_con_reset_addrinfo(drizzle_con_st *con);
	63
	64	/**
	65	* Check if state stack is empty.
	66	*
	67	* @param[in] con Connection structure previously initialized with
	68	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	69	* @return True if empty, false if something is on the stack.
	70	*/
	71	static inline bool drizzle_state_none(drizzle_con_st *con)
	72	{
2472.1.2 by Brian Aker Null safety fix for libdrizzle	73	if (con == NULL)
	74	{
	75	return false;
	76	}
	77
1712.1.1 by Monty Taylor Merged libdrizzle directly into tree.	78	return con->state_current == 0;
	79	}
	80
	81	/**
	82	* Push a function onto the stack.
	83	*
	84	* @param[in] con Connection structure previously initialized with
	85	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	86	* @param[in] function Function to push.
	87	*/
	88	static inline void drizzle_state_push(drizzle_con_st *con,
	89	drizzle_state_fn *function)
	90	{
	91	/* The maximum stack depth can be determined at compile time, so bump this
	92	constant if needed to avoid the dynamic memory management. */
	93	assert(con->state_current < DRIZZLE_STATE_STACK_SIZE);
	94	con->state_stack[con->state_current]= function;
	95	con->state_current++;
	96	}
	97
	98	/**
	99	* Pop a function off of the stack.
	100	*
	101	* @param[in] con Connection structure previously initialized with
	102	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	103	*/
	104	static inline void drizzle_state_pop(drizzle_con_st *con)
	105	{
	106	con->state_current--;
	107	}
	108
	109	/**
	110	* Reset the stack so it is empty.
	111	*
	112	* @param[in] con Connection structure previously initialized with
	113	* drizzle_con_create(), drizzle_con_clone(), or related functions.
	114	*/
	115	static inline void drizzle_state_reset(drizzle_con_st *con)
	116	{
	117	con->state_current= 0;
	118	}
	119
	120	/** @} */
	121
	122	#ifdef __cplusplus
	123	}
	124	#endif