Gearman Public API Documentation

libgearman/constants.h File Reference

Defines, typedefs, and enums. More...

Go to the source code of this file.

Defines

#define GEARMAN_DEFAULT_TCP_HOST   "127.0.0.1"
#define GEARMAN_DEFAULT_TCP_PORT   4730
#define GEARMAN_DEFAULT_SOCKET_TIMEOUT   10
#define GEARMAN_DEFAULT_SOCKET_SEND_SIZE   32768
#define GEARMAN_DEFAULT_SOCKET_RECV_SIZE   32768
#define GEARMAN_MAX_ERROR_SIZE   1024
#define GEARMAN_PACKET_HEADER_SIZE   12
#define GEARMAN_JOB_HANDLE_SIZE   64
#define GEARMAN_OPTION_SIZE   64
#define GEARMAN_UNIQUE_SIZE   64
#define GEARMAN_MAX_COMMAND_ARGS   8
#define GEARMAN_ARGS_BUFFER_SIZE   128
#define GEARMAN_SEND_BUFFER_SIZE   8192
#define GEARMAN_RECV_BUFFER_SIZE   8192
#define GEARMAN_WORKER_WAIT_TIMEOUT   (10 * 1000)

Typedefs

typedef struct gearman_st gearman_st
typedef struct gearman_con_st gearman_con_st
typedef struct gearman_packet_st gearman_packet_st
typedef struct
gearman_command_info_st 
gearman_command_info_st
typedef struct gearman_task_st gearman_task_st
typedef struct gearman_client_st gearman_client_st
typedef struct gearman_job_st gearman_job_st
typedef struct gearman_worker_st gearman_worker_st
typedef struct
gearman_worker_function_st 
gearman_worker_function_st
typedef gearman_return_tgearman_workload_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_created_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_data_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_warning_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_status_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_complete_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_exception_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_fail_fn )(gearman_task_st *task)
typedef gearman_return_tgearman_parse_server_fn )(const char *host, in_port_t port, void *context)
typedef void *( gearman_worker_fn )(gearman_job_st *job, void *context, size_t *result_size, gearman_return_t *ret_ptr)
typedef gearman_return_tgearman_event_watch_fn )(gearman_con_st *con, short events, void *context)
typedef void *( gearman_malloc_fn )(size_t size, void *context)
typedef void( gearman_free_fn )(void *ptr, void *context)
typedef void( gearman_task_context_free_fn )(gearman_task_st *task, void *context)
typedef void( gearman_log_fn )(const char *line, gearman_verbose_t verbose, void *context)
typedef void( gearman_con_protocol_context_free_fn )(gearman_con_st *con, void *context)
typedef size_t( gearman_packet_pack_fn )(const gearman_packet_st *packet, gearman_con_st *con, void *data, size_t data_size, gearman_return_t *ret_ptr)
typedef size_t( gearman_packet_unpack_fn )(gearman_packet_st *packet, gearman_con_st *con, const void *data, size_t data_size, gearman_return_t *ret_ptr)

Enumerations

enum  gearman_return_t {
  GEARMAN_SUCCESS, GEARMAN_IO_WAIT, GEARMAN_SHUTDOWN, GEARMAN_SHUTDOWN_GRACEFUL,
  GEARMAN_ERRNO, GEARMAN_EVENT, GEARMAN_TOO_MANY_ARGS, GEARMAN_NO_ACTIVE_FDS,
  GEARMAN_INVALID_MAGIC, GEARMAN_INVALID_COMMAND, GEARMAN_INVALID_PACKET, GEARMAN_UNEXPECTED_PACKET,
  GEARMAN_GETADDRINFO, GEARMAN_NO_SERVERS, GEARMAN_LOST_CONNECTION, GEARMAN_MEMORY_ALLOCATION_FAILURE,
  GEARMAN_JOB_EXISTS, GEARMAN_JOB_QUEUE_FULL, GEARMAN_SERVER_ERROR, GEARMAN_WORK_ERROR,
  GEARMAN_WORK_DATA, GEARMAN_WORK_WARNING, GEARMAN_WORK_STATUS, GEARMAN_WORK_EXCEPTION,
  GEARMAN_WORK_FAIL, GEARMAN_NOT_CONNECTED, GEARMAN_COULD_NOT_CONNECT, GEARMAN_SEND_IN_PROGRESS,
  GEARMAN_RECV_IN_PROGRESS, GEARMAN_NOT_FLUSHING, GEARMAN_DATA_TOO_LARGE, GEARMAN_INVALID_FUNCTION_NAME,
  GEARMAN_INVALID_WORKER_FUNCTION, GEARMAN_NO_REGISTERED_FUNCTIONS, GEARMAN_NO_JOBS, GEARMAN_ECHO_DATA_CORRUPTION,
  GEARMAN_NEED_WORKLOAD_FN, GEARMAN_PAUSE, GEARMAN_UNKNOWN_STATE, GEARMAN_PTHREAD,
  GEARMAN_PIPE_EOF, GEARMAN_QUEUE_ERROR, GEARMAN_FLUSH_DATA, GEARMAN_SEND_BUFFER_TOO_SMALL,
  GEARMAN_IGNORE_PACKET, GEARMAN_UNKNOWN_OPTION, GEARMAN_TIMEOUT, GEARMAN_MAX_RETURN
}
enum  gearman_verbose_t {
  GEARMAN_VERBOSE_FATAL, GEARMAN_VERBOSE_ERROR, GEARMAN_VERBOSE_INFO, GEARMAN_VERBOSE_DEBUG,
  GEARMAN_VERBOSE_CRAZY, GEARMAN_VERBOSE_MAX
}
enum  gearman_options_t { GEARMAN_ALLOCATED = (1 << 0), GEARMAN_NON_BLOCKING = (1 << 1), GEARMAN_DONT_TRACK_PACKETS = (1 << 2) }
enum  gearman_con_options_t {
  GEARMAN_CON_ALLOCATED = (1 << 0), GEARMAN_CON_READY = (1 << 1), GEARMAN_CON_PACKET_IN_USE = (1 << 2), GEARMAN_CON_EXTERNAL_FD = (1 << 3),
  GEARMAN_CON_IGNORE_LOST_CONNECTION = (1 << 4), GEARMAN_CON_CLOSE_AFTER_FLUSH = (1 << 5)
}
enum  gearman_con_state_t { GEARMAN_CON_STATE_ADDRINFO, GEARMAN_CON_STATE_CONNECT, GEARMAN_CON_STATE_CONNECTING, GEARMAN_CON_STATE_CONNECTED }
enum  gearman_con_send_state_t {
  GEARMAN_CON_SEND_STATE_NONE, GEARMAN_CON_SEND_STATE_PRE_FLUSH, GEARMAN_CON_SEND_STATE_FORCE_FLUSH, GEARMAN_CON_SEND_STATE_FLUSH,
  GEARMAN_CON_SEND_STATE_FLUSH_DATA
}
enum  gearman_con_recv_state_t { GEARMAN_CON_RECV_STATE_NONE, GEARMAN_CON_RECV_STATE_READ, GEARMAN_CON_RECV_STATE_READ_DATA }
enum  gearman_packet_options_t { GEARMAN_PACKET_ALLOCATED = (1 << 0), GEARMAN_PACKET_COMPLETE = (1 << 1), GEARMAN_PACKET_FREE_DATA = (1 << 2) }
enum  gearman_magic_t { GEARMAN_MAGIC_TEXT, GEARMAN_MAGIC_REQUEST, GEARMAN_MAGIC_RESPONSE }
enum  gearman_command_t {
  GEARMAN_COMMAND_TEXT, GEARMAN_COMMAND_CAN_DO, GEARMAN_COMMAND_CANT_DO, GEARMAN_COMMAND_RESET_ABILITIES,
  GEARMAN_COMMAND_PRE_SLEEP, GEARMAN_COMMAND_UNUSED, GEARMAN_COMMAND_NOOP, GEARMAN_COMMAND_SUBMIT_JOB,
  GEARMAN_COMMAND_JOB_CREATED, GEARMAN_COMMAND_GRAB_JOB, GEARMAN_COMMAND_NO_JOB, GEARMAN_COMMAND_JOB_ASSIGN,
  GEARMAN_COMMAND_WORK_STATUS, GEARMAN_COMMAND_WORK_COMPLETE, GEARMAN_COMMAND_WORK_FAIL, GEARMAN_COMMAND_GET_STATUS,
  GEARMAN_COMMAND_ECHO_REQ, GEARMAN_COMMAND_ECHO_RES, GEARMAN_COMMAND_SUBMIT_JOB_BG, GEARMAN_COMMAND_ERROR,
  GEARMAN_COMMAND_STATUS_RES, GEARMAN_COMMAND_SUBMIT_JOB_HIGH, GEARMAN_COMMAND_SET_CLIENT_ID, GEARMAN_COMMAND_CAN_DO_TIMEOUT,
  GEARMAN_COMMAND_ALL_YOURS, GEARMAN_COMMAND_WORK_EXCEPTION, GEARMAN_COMMAND_OPTION_REQ, GEARMAN_COMMAND_OPTION_RES,
  GEARMAN_COMMAND_WORK_DATA, GEARMAN_COMMAND_WORK_WARNING, GEARMAN_COMMAND_GRAB_JOB_UNIQ, GEARMAN_COMMAND_JOB_ASSIGN_UNIQ,
  GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG, GEARMAN_COMMAND_SUBMIT_JOB_LOW, GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG, GEARMAN_COMMAND_SUBMIT_JOB_SCHED,
  GEARMAN_COMMAND_SUBMIT_JOB_EPOCH, GEARMAN_COMMAND_MAX
}
enum  gearman_task_options_t { GEARMAN_TASK_ALLOCATED = (1 << 0), GEARMAN_TASK_SEND_IN_USE = (1 << 1) }
enum  gearman_task_state_t {
  GEARMAN_TASK_STATE_NEW, GEARMAN_TASK_STATE_SUBMIT, GEARMAN_TASK_STATE_WORKLOAD, GEARMAN_TASK_STATE_WORK,
  GEARMAN_TASK_STATE_CREATED, GEARMAN_TASK_STATE_DATA, GEARMAN_TASK_STATE_WARNING, GEARMAN_TASK_STATE_STATUS,
  GEARMAN_TASK_STATE_COMPLETE, GEARMAN_TASK_STATE_EXCEPTION, GEARMAN_TASK_STATE_FAIL, GEARMAN_TASK_STATE_FINISHED
}
enum  gearman_job_options_t { GEARMAN_JOB_ALLOCATED = (1 << 0), GEARMAN_JOB_ASSIGNED_IN_USE = (1 << 1), GEARMAN_JOB_WORK_IN_USE = (1 << 2), GEARMAN_JOB_FINISHED = (1 << 3) }
enum  gearman_job_priority_t { GEARMAN_JOB_PRIORITY_HIGH, GEARMAN_JOB_PRIORITY_NORMAL, GEARMAN_JOB_PRIORITY_LOW, GEARMAN_JOB_PRIORITY_MAX }
enum  gearman_client_options_t {
  GEARMAN_CLIENT_ALLOCATED = (1 << 0), GEARMAN_CLIENT_NON_BLOCKING = (1 << 1), GEARMAN_CLIENT_TASK_IN_USE = (1 << 2), GEARMAN_CLIENT_UNBUFFERED_RESULT = (1 << 3),
  GEARMAN_CLIENT_NO_NEW = (1 << 4), GEARMAN_CLIENT_FREE_TASKS = (1 << 5)
}
enum  gearman_client_state_t { GEARMAN_CLIENT_STATE_IDLE, GEARMAN_CLIENT_STATE_NEW, GEARMAN_CLIENT_STATE_SUBMIT, GEARMAN_CLIENT_STATE_PACKET }
enum  gearman_worker_options_t {
  GEARMAN_WORKER_ALLOCATED = (1 << 0), GEARMAN_WORKER_NON_BLOCKING = (1 << 1), GEARMAN_WORKER_PACKET_INIT = (1 << 2), GEARMAN_WORKER_GRAB_JOB_IN_USE = (1 << 3),
  GEARMAN_WORKER_PRE_SLEEP_IN_USE = (1 << 4), GEARMAN_WORKER_WORK_JOB_IN_USE = (1 << 5), GEARMAN_WORKER_CHANGE = (1 << 6), GEARMAN_WORKER_GRAB_UNIQ = (1 << 7),
  GEARMAN_WORKER_TIMEOUT_RETURN = (1 << 8)
}
enum  gearman_worker_state_t {
  GEARMAN_WORKER_STATE_START, GEARMAN_WORKER_STATE_FUNCTION_SEND, GEARMAN_WORKER_STATE_CONNECT, GEARMAN_WORKER_STATE_GRAB_JOB_SEND,
  GEARMAN_WORKER_STATE_GRAB_JOB_RECV, GEARMAN_WORKER_STATE_PRE_SLEEP
}
enum  gearman_worker_function_options_t { GEARMAN_WORKER_FUNCTION_PACKET_IN_USE = (1 << 0), GEARMAN_WORKER_FUNCTION_CHANGE = (1 << 1), GEARMAN_WORKER_FUNCTION_REMOVE = (1 << 2) }
enum  gearman_worker_work_state_t { GEARMAN_WORKER_WORK_STATE_GRAB_JOB, GEARMAN_WORKER_WORK_STATE_FUNCTION, GEARMAN_WORKER_WORK_STATE_COMPLETE, GEARMAN_WORKER_WORK_STATE_FAIL }

Detailed Description

Defines, typedefs, and enums.

Definition in file constants.h.


Generated on Tue Oct 13 20:19:20 2009 by  doxygen 1.6.1