Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
GEARMAN_CLIENT_CLEAR_FN(3)	   Gearmand	    GEARMAN_CLIENT_CLEAR_FN(3)

NAME
       gearman_client_clear_fn - Gearmand Documentation, http://gearman.info/

SYNOPSIS
       #include	<libgearman/gearman.h>

       gearman_actions_t

       gearman_workload_fn

       gearman_created_fn

       gearman_data_fn

       gearman_warning_fn

       gearman_universal_status_fn

       gearman_exception_fn

       gearman_fail_fn

       gearman_complete_fn

       void	     gearman_client_set_workload_fn(gearman_client_st *client,
       gearman_workload_fn *function)

       void	      gearman_client_set_created_fn(gearman_client_st *client,
       gearman_created_fn *function)

       void		 gearman_client_set_data_fn(gearman_client_st *client,
       gearman_data_fn *function)

       void	      gearman_client_set_warning_fn(gearman_client_st *client,
       gearman_warning_fn *function)

       void	       gearman_client_set_status_fn(gearman_client_st *client,
       gearman_universal_status_fn *function)

       void	     gearman_client_set_complete_fn(gearman_client_st *client,
       gearman_complete_fn *function)

       void	    gearman_client_set_exception_fn(gearman_client_st *client,
       gearman_exception_fn *function)

       void		 gearman_client_set_fail_fn(gearman_client_st *client,
       gearman_fail_fn *function)

       void gearman_client_clear_fn(gearman_client_st *client)

       const char *gearman_client_do_job_handle(gearman_client_st *client)

       Link to -lgearman

DESCRIPTION
       Callbacks for client execution task states.

       gearman_client_set_data_fn()  sets  the	callback function that will be
       called if server	is to make a request to	the  client  to	 provide  more
       data.

       gearman_client_do_job_handle()  gest  the  job  handle  for the running
       task. This should be used between repeated gearman_client_do() (and re-
       lated) calls to get information.

       gearman_client_clear_fn()   can	 be  called  to	 remove	 all  existing
       gearman_actions_t that have been	set.

       gearman_client_set_created_fn(),		 gearman_client_set_data_fn(),
       gearman_client_set_warning_fn(),	       gearman_client_set_status_fn(),
       gearman_client_set_complete_fn(),    gearman_client_set_exception_fn(),
       and  gearman_client_set_fail_fn(),  set callback	functions for the dif-
       ferent states of	execution for a	client request.	 Each  request,	 ie  a
       creation	 of gearman_task_st, keeps a copy of callbacks when it is cre-
       ated.

       gearman_client_set_exception_fn() will only be called if	exceptions are
       enabled	 on   the   server.   You   can	  do  this  by	calling	 gear-
       man_client_set_server_option().

       An example of this:

	  const	char *EXCEPTIONS="exceptions";
	  gearman_client_set_server_option(client, EXCEPTIONS, strlen(EXCEPTIONS));

RETURN VALUE
       None

	  See also

		 gearmand(8) libgearman(3)  gearman_client_error(3)  or	 gear-
		 man_worker_error(3)

AUTHOR
       Data Differential http://www.datadifferential.com/

COPYRIGHT
       2011-2013, Data Differential, http://www.datadifferential.com/

1.1.8				 June 06, 2013	    GEARMAN_CLIENT_CLEAR_FN(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=gearman_client_clear_fn&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help