root / ncclient / operations / rpc.py @ a956ef07
History | View | Annotate | Download (3.1 kB)
1 | 589b23e4 | Shikhar Bhushan | # Copyright 2009 Shikhar Bhushan
|
---|---|---|---|
2 | 589b23e4 | Shikhar Bhushan | #
|
3 | 589b23e4 | Shikhar Bhushan | # Licensed under the Apache License, Version 2.0 (the "License");
|
4 | 589b23e4 | Shikhar Bhushan | # you may not use this file except in compliance with the License.
|
5 | 589b23e4 | Shikhar Bhushan | # You may obtain a copy of the License at
|
6 | 589b23e4 | Shikhar Bhushan | #
|
7 | 589b23e4 | Shikhar Bhushan | # http://www.apache.org/licenses/LICENSE-2.0
|
8 | 589b23e4 | Shikhar Bhushan | #
|
9 | 589b23e4 | Shikhar Bhushan | # Unless required by applicable law or agreed to in writing, software
|
10 | 589b23e4 | Shikhar Bhushan | # distributed under the License is distributed on an "AS IS" BASIS,
|
11 | 589b23e4 | Shikhar Bhushan | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 | 589b23e4 | Shikhar Bhushan | # See the License for the specific language governing permissions and
|
13 | 589b23e4 | Shikhar Bhushan | # limitations under the License.
|
14 | 589b23e4 | Shikhar Bhushan | |
15 | a956ef07 | Shikhar Bhushan | 'Remote Procedure Call'
|
16 | a956ef07 | Shikhar Bhushan | |
17 | 38a9b062 | Shikhar Bhushan | from threading import Event, Lock |
18 | 38a9b062 | Shikhar Bhushan | from uuid import uuid1 |
19 | 38a9b062 | Shikhar Bhushan | |
20 | a956ef07 | Shikhar Bhushan | _listeners = WeakValueDictionary() |
21 | a956ef07 | Shikhar Bhushan | |
22 | a956ef07 | Shikhar Bhushan | def get_listener(session): |
23 | a956ef07 | Shikhar Bhushan | try:
|
24 | a956ef07 | Shikhar Bhushan | return _listeners[session]
|
25 | a956ef07 | Shikhar Bhushan | except KeyError: |
26 | a956ef07 | Shikhar Bhushan | _listeners[session] = MessageListener() |
27 | a956ef07 | Shikhar Bhushan | return _listeners[session]
|
28 | ee4bb099 | Shikhar Bhushan | |
29 | 589b23e4 | Shikhar Bhushan | class RPC: |
30 | 589b23e4 | Shikhar Bhushan | |
31 | ee4bb099 | Shikhar Bhushan | def __init__(self, session, async=False, parse=True): |
32 | 38a9b062 | Shikhar Bhushan | self._session = session
|
33 | 38a9b062 | Shikhar Bhushan | self._async = async
|
34 | ee4bb099 | Shikhar Bhushan | self._id = uuid1().urn
|
35 | 589b23e4 | Shikhar Bhushan | self._reply = None |
36 | 38a9b062 | Shikhar Bhushan | self._reply_event = Event()
|
37 | a956ef07 | Shikhar Bhushan | self.listener.register(self._id, self) |
38 | a956ef07 | Shikhar Bhushan | session.add_listener(self.listener)
|
39 | 38a9b062 | Shikhar Bhushan | |
40 | ee4bb099 | Shikhar Bhushan | def _response_cb(self, reply): |
41 | ee4bb099 | Shikhar Bhushan | self._reply = reply
|
42 | 589b23e4 | Shikhar Bhushan | self._event.set()
|
43 | 38a9b062 | Shikhar Bhushan | |
44 | c3d6fa74 | Shikhar Bhushan | def _do_request(self, operation): |
45 | c3d6fa74 | Shikhar Bhushan | 'operation is xml string'
|
46 | c3d6fa74 | Shikhar Bhushan | self._session.send(content.RPC.make(self._id, operation)) |
47 | ee4bb099 | Shikhar Bhushan | if not self._async: |
48 | ee4bb099 | Shikhar Bhushan | self._reply_event.wait()
|
49 | ee4bb099 | Shikhar Bhushan | return self._reply |
50 | ee4bb099 | Shikhar Bhushan | |
51 | ee4bb099 | Shikhar Bhushan | def request(self): |
52 | ee4bb099 | Shikhar Bhushan | raise NotImplementedError |
53 | ee4bb099 | Shikhar Bhushan | |
54 | ee4bb099 | Shikhar Bhushan | def wait_for_reply(self, timeout=None): |
55 | ee4bb099 | Shikhar Bhushan | self._reply_event.wait(timeout)
|
56 | ee4bb099 | Shikhar Bhushan | |
57 | 589b23e4 | Shikhar Bhushan | @property
|
58 | 35ad9d81 | Shikhar Bhushan | def has_reply(self): |
59 | 38a9b062 | Shikhar Bhushan | return self._reply_event.isSet() |
60 | 38a9b062 | Shikhar Bhushan | |
61 | 589b23e4 | Shikhar Bhushan | @property
|
62 | 35ad9d81 | Shikhar Bhushan | def is_async(self): |
63 | 35ad9d81 | Shikhar Bhushan | return self._async |
64 | 589b23e4 | Shikhar Bhushan | |
65 | 589b23e4 | Shikhar Bhushan | @property
|
66 | ee4bb099 | Shikhar Bhushan | def reply(self): |
67 | ee4bb099 | Shikhar Bhushan | return self._reply |
68 | ee4bb099 | Shikhar Bhushan | |
69 | ee4bb099 | Shikhar Bhushan | @property
|
70 | 38a9b062 | Shikhar Bhushan | def id(self): |
71 | ee4bb099 | Shikhar Bhushan | return self._id |
72 | ee4bb099 | Shikhar Bhushan | |
73 | ee4bb099 | Shikhar Bhushan | @property
|
74 | a956ef07 | Shikhar Bhushan | def listener(self): |
75 | a956ef07 | Shikhar Bhushan | listener = get_listener(self._session)
|
76 | a956ef07 | Shikhar Bhushan | |
77 | a956ef07 | Shikhar Bhushan | @property
|
78 | ee4bb099 | Shikhar Bhushan | def session(self): |
79 | ee4bb099 | Shikhar Bhushan | return self._session |
80 | ee4bb099 | Shikhar Bhushan | |
81 | ee4bb099 | Shikhar Bhushan | class RPCReply: |
82 | 2acc860a | Shikhar Bhushan | |
83 | 2acc860a | Shikhar Bhushan | class RPCError: |
84 | 2acc860a | Shikhar Bhushan | |
85 | a956ef07 | Shikhar Bhushan | pass
|
86 | a956ef07 | Shikhar Bhushan | |
87 | a956ef07 | Shikhar Bhushan | |
88 | a956ef07 | Shikhar Bhushan | class MessageListener: |
89 | a956ef07 | Shikhar Bhushan | |
90 | a956ef07 | Shikhar Bhushan | def __init__(self): |
91 | a956ef07 | Shikhar Bhushan | # {message-id: RPC}
|
92 | a956ef07 | Shikhar Bhushan | self._rpc = WeakValueDictionary()
|
93 | a956ef07 | Shikhar Bhushan | # if the session gets closed by remote endpoint,
|
94 | a956ef07 | Shikhar Bhushan | # need to know if it is an error event or was requested through
|
95 | a956ef07 | Shikhar Bhushan | # a NETCONF operation i.e. CloseSession
|
96 | a956ef07 | Shikhar Bhushan | self._expecting_close = False |
97 | a956ef07 | Shikhar Bhushan | # other recognized names and behavior on receiving them
|
98 | a956ef07 | Shikhar Bhushan | self._recognized = []
|
99 | a956ef07 | Shikhar Bhushan | |
100 | a956ef07 | Shikhar Bhushan | def __str__(self): |
101 | a956ef07 | Shikhar Bhushan | return 'MessageListener' |
102 | a956ef07 | Shikhar Bhushan | |
103 | a956ef07 | Shikhar Bhushan | def expect_close(self): |
104 | a956ef07 | Shikhar Bhushan | self._expecting_close = True |
105 | a956ef07 | Shikhar Bhushan | |
106 | a956ef07 | Shikhar Bhushan | def register(self, id, op): |
107 | a956ef07 | Shikhar Bhushan | self._id2rpc[id] = op |
108 | a956ef07 | Shikhar Bhushan | |
109 | a956ef07 | Shikhar Bhushan | ### Events
|
110 | a956ef07 | Shikhar Bhushan | |
111 | a956ef07 | Shikhar Bhushan | def reply(self, raw): |
112 | a956ef07 | Shikhar Bhushan | pass
|
113 | a956ef07 | Shikhar Bhushan | |
114 | a956ef07 | Shikhar Bhushan | def error(self, err): |
115 | a956ef07 | Shikhar Bhushan | from ncclient.session.session import SessionCloseError |
116 | a956ef07 | Shikhar Bhushan | if err is SessionCloseError: |
117 | a956ef07 | Shikhar Bhushan | logger.debug('session closed by remote endpoint, expecting_close=%s' %
|
118 | a956ef07 | Shikhar Bhushan | self._expecting_close)
|
119 | a956ef07 | Shikhar Bhushan | if not self._expecting_close: |
120 | a956ef07 | Shikhar Bhushan | raise err
|