summaryrefslogtreecommitdiff
path: root/source4/libcli/composite/composite.c
blob: 6458a971b434c4fdbc85dddf065213525333e24d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/* 
   Unix SMB/CIFS implementation.

   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.
*/
/*
  composite API helper functions
*/

#include "includes.h"
#include "lib/events/events.h"
#include "libcli/raw/libcliraw.h"
#include "libcli/composite/composite.h"
#include "lib/messaging/irpc.h"

/*
  block until a composite function has completed, then return the status
*/
NTSTATUS composite_wait(struct composite_context *c)
{
	if (c == NULL) return NT_STATUS_NO_MEMORY;

	while (c->state < COMPOSITE_STATE_DONE) {
		if (event_loop_once(c->event_ctx) != 0) {
			return NT_STATUS_UNSUCCESSFUL;
		}
	}

	return c->status;
}


/* 
   callback from composite_trigger_done() 
*/
static void composite_trigger(struct event_context *ev, struct timed_event *te,
			      struct timeval t, void *ptr)
{
	struct composite_context *c = talloc_get_type(ptr, struct composite_context);
	if (c->async.fn) {
		c->async.fn(c);
	}
}


/*
  trigger an immediate 'done' event on a composite context
  this is used when the composite code works out that the call
  can be completed without waiting for any external event
*/
void composite_trigger_done(struct composite_context *c)
{
	c->state = COMPOSITE_STATE_DONE;
	/* a zero timeout means immediate */
	event_add_timed(c->event_ctx, c, timeval_zero(), composite_trigger, c);
}


/*
 * Some composite helpers that are handy if you write larger composite
 * functions.
 */

BOOL comp_is_ok(struct composite_context *ctx)
{
	if (NT_STATUS_IS_OK(ctx->status)) {
		return True;
	}
	ctx->state = COMPOSITE_STATE_ERROR;
	if (ctx->async.fn != NULL) {
		ctx->async.fn(ctx);
	}
	return False;
}

void comp_error(struct composite_context *ctx, NTSTATUS status)
{
	ctx->status = status;
	SMB_ASSERT(!comp_is_ok(ctx));
}

BOOL comp_nomem(const void *p, struct composite_context *ctx)
{
	if (p != NULL) {
		return False;
	}
	comp_error(ctx, NT_STATUS_NO_MEMORY);
	return True;
}

void comp_done(struct composite_context *ctx)
{
	ctx->state = COMPOSITE_STATE_DONE;
	if (ctx->async.fn != NULL) {
		ctx->async.fn(ctx);
	}
}

void comp_cont(struct composite_context *ctx,
	       struct composite_context *new_ctx,
	       void (*continuation)(struct composite_context *),
	       void *private_data)
{
	if (comp_nomem(new_ctx, ctx)) return;
	new_ctx->async.fn = continuation;
	new_ctx->async.private_data = private_data;
}

void rpc_cont(struct composite_context *ctx,
	      struct rpc_request *new_req,
	      void (*continuation)(struct rpc_request *),
	      void *private_data)
{
	if (comp_nomem(new_req, ctx)) return;
	new_req->async.callback = continuation;
	new_req->async.private = private_data;
}

void irpc_cont(struct composite_context *ctx,
	       struct irpc_request *new_req,
	       void (*continuation)(struct irpc_request *),
	       void *private_data)
{
	if (comp_nomem(new_req, ctx)) return;
	new_req->async.fn = continuation;
	new_req->async.private = private_data;
}