123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154 |
- /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
- *
- * Gearmand client and server library.
- *
- * Copyright (C) 2011-2012 Data Differential, http://datadifferential.com/
- * Copyright (C) 2008 Brian Aker, Eric Day
- * 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.
- *
- */
- /**
- * @file
- * @brief Packet Declarations
- */
- #pragma once
- #include <libgearman-server/struct/packet.h>
- #include <libgearman-1.0/protocol.h>
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @addtogroup gearman_server_packet Packet Declarations
- * @ingroup gearman_server
- *
- * This is a low level interface for gearman server connections. This is used
- * internally by the server interface, so you probably want to look there first.
- *
- * @{
- */
- /**
- * Initialize a server packet structure.
- */
- GEARMAN_API
- gearman_server_packet_st *
- gearman_server_packet_create(gearman_server_thread_st *thread,
- bool from_thread);
- const char *gearmand_strcommand(gearmand_packet_st *packet);
- /**
- * Free a server connection structure.
- */
- GEARMAN_API
- void gearman_server_packet_free(gearman_server_packet_st *packet,
- gearman_server_thread_st *thread,
- bool from_thread);
- /**
- * Add a server packet structure to io queue for a connection.
- */
- GEARMAN_API
- gearmand_error_t gearman_server_io_packet_add(gearman_server_con_st *con,
- bool take_data,
- enum gearman_magic_t magic,
- gearman_command_t command,
- const void *arg, ...);
- /**
- * Remove the first server packet structure from io queue for a connection.
- */
- GEARMAN_API
- void gearman_server_io_packet_remove(gearman_server_con_st *con);
- /**
- * Add a server packet structure to proc queue for a connection.
- */
- GEARMAN_API
- void gearman_server_proc_packet_add(gearman_server_con_st *con,
- gearman_server_packet_st *packet);
- /**
- * Remove the first server packet structure from proc queue for a connection.
- */
- GEARMAN_API
- gearman_server_packet_st *
- gearman_server_proc_packet_remove(gearman_server_con_st *con);
- /**
- * Initialize a packet structure.
- *
- * @param[in] gearman Structure previously initialized with gearman_create() or
- * gearman_clone().
- * @param[in] packet Caller allocated structure, or NULL to allocate one.
- * @return On success, a pointer to the (possibly allocated) structure. On
- * failure this will be NULL.
- */
- GEARMAN_INTERNAL_API
- void gearmand_packet_init(gearmand_packet_st *packet, enum gearman_magic_t magic, gearman_command_t command);
- /**
- * Free a packet structure.
- *
- * @param[in] packet Structure previously initialized with
- * gearmand_packet_init() or gearmand_packet_creates().
- */
- GEARMAN_INTERNAL_API
- void gearmand_packet_free(gearmand_packet_st *packet);
- /**
- * Add an argument to a packet.
- */
- GEARMAN_INTERNAL_API
- gearmand_error_t gearmand_packet_create(gearmand_packet_st *packet,
- const void *arg, size_t arg_size);
- /**
- * Pack header.
- */
- GEARMAN_INTERNAL_API
- gearmand_error_t gearmand_packet_pack_header(gearmand_packet_st *packet);
- void destroy_gearman_server_packet_st(gearman_server_packet_st *packet);
- /** @} */
- #ifdef __cplusplus
- }
- #endif
|