Includes cleanups
[invirt/third/libt4.git] / handle.h
1 // manage a cache of RPC connections.
2 // assuming cid is a string holding the
3 // host:port of the RPC server you want
4 // to talk to:
5 //
6 // handle h(cid);
7 // rpcc *cl = h.safebind();
8 // if(cl){
9 //   ret = cl->call(...);
10 // } else {
11 //   bind() failed
12 // }
13 //
14 // if the calling program has not contacted
15 // cid before, safebind() will create a new
16 // connection, call bind(), and return
17 // an rpcc*, or 0 if bind() failed. if the
18 // program has previously contacted cid,
19 // safebind() just returns the previously
20 // created rpcc*. best not to hold any
21 // mutexes while calling safebind().
22
23 #ifndef handle_h
24 #define handle_h
25
26 #include "types.h"
27 #include "rpc/rpc.h"
28
29 class hinfo;
30
31 class handle {
32     private:
33         shared_ptr<hinfo> h;
34     public:
35         handle(const string & m);
36         /* safebind will try to bind with the rpc server on the first call.
37          * Since bind may block, the caller probably should not hold a mutex
38          * when calling safebind.
39          *
40          * return: 
41          *   if the first safebind succeeded, all later calls would return
42          *   a rpcc object; otherwise, all later calls would return NULL.
43          *
44          * Example:
45          *   handle h(dst);
46          *   XXX_protocol::status ret;
47          *   if (h.safebind()) {
48          *     ret = h.safebind()->call(...);
49          *   }
50          *   if (!h.safebind() || ret != XXX_protocol::OK) {
51          *     // handle failure
52          *   }
53          */
54         rpcc *safebind();
55
56         void invalidate();
57 };
58
59 void invalidate_handle(const string & m);
60
61 #endif