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
|
#
# Copyright 2015 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# GNU Radio 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 3, or (at your option)
# any later version.
#
# GNU Radio 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
import exceptions
"""
RPCMethods is a dictionary listing RPC transports currently supported
by this client.
Args:
function: the function whose parameter list will be examined
excluded_args: function arguments that are NOT to be added to the dictionary (sequence of strings)
options: result of command argument parsing (optparse.Values)
"""
RPCMethods = {'thrift': 'Apache Thrift',
#'ice': 'Zeroc ICE'
}
"""
Base class for RPC transport clients
Methods that all RPC clients should implement include:
def newConnection(host,port): Method for re-establishing a new client
connection to a different host / port
def properties([]): Given a list of ControlPort property names,
or an empty list to specify all currently registered properties,
this method returns a dictionary of metadata describing the
the specified properties. The dictionary key contains the name
of each returned properties.
def getKnobs([]): Given a list of ControlPort property names,
or an empty list to specify all currently registered properties,
this method returns a dictionary of the current value of
the specified properties.
def getRe([]): Given a list of regular expression strings,
this method returns a dictionary of the current value of
the all properties with names that match the specified
expressions.
def setKnobs({}): Given a dictionary of ControlPort property
key / value pairs, this method requests that ControlPort
attempt to set the specified named properties to the
value given. Success in setting each property to the
value specified requires that the property be registered
as a 'setable' ControlPort property, that the client have the
requisite privilege level to set the property, and
the underlying Block's implementation in handling
the set request.
Args:
method: name of the RPC transport
port: port number of the connection
host: hostname of the connection
"""
class RPCConnection(object):
def __init__(self, method, port, host=None):
(self.method, self.port) = (method, port)
if host is None: self.host = '127.0.0.1'
else: self.host = host
def __str__(self):
return "%s connection on %s:%s"%(self.getName(), self.getHost(), self.getPort())
def getName(self):
return RPCMethods[self.method]
def getHost(self):
return self.host
def getPort(self):
return self.port
def newConnection(self, host=None, port=None):
raise exceptions.NotImplementedError()
def properties(self, *args):
raise exceptions.NotImplementedError()
def getKnobs(self, *args):
raise exceptions.NotImplementedError()
def getRe(self,*args):
raise exceptions.NotImplementedError()
def postMessage(self,*args):
raise exceptions.NotImplementedError()
def setKnobs(self,*args):
raise exceptions.NotImplementedError()
def shutdown(self):
raise exceptions.NotImplementedError()
def printProperties(self, props):
raise exceptions.NotImplementedError()
|
