samba-mirror/source4/libcli/composite/composite.h

/* 
   Unix SMB/CIFS implementation.

   composite request interfaces

   Copyright (C) Andrew Tridgell 2005
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/*
  this defines the structures associated with "composite"
  requests. Composite requests are libcli requests that are internally
  implemented as multiple async calls, but can be treated as a
  single call via these composite calls. The composite calls are
  particularly designed to be used in async applications.
  you can also stack multiple level of composite call
*/

/*
  a composite call moves between the following 3 states.
*/
enum composite_state { COMPOSITE_STATE_INIT,         /* we are creating the request */
		       COMPOSITE_STATE_IN_PROGRESS,  /* the request is in the outgoing socket Q */
		       COMPOSITE_STATE_DONE,         /* the request is received by the caller finished */
		       COMPOSITE_STATE_ERROR };      /* a packet or transport level error has occurred */

/* the context of one "composite" call */
struct composite_context {
	/* the external state - will be queried by the caller */
	enum composite_state state;

	/* a private pointer for use by the composite function
	   implementation */
	void *private_data;

	/* status code when finished */
	NTSTATUS status;

	/* the event context we are using */
	struct event_context *event_ctx;

	/* information on what to do on completion */
	struct {
		void (*fn)(struct composite_context *);
		void *private_data;
	} async;
};