1nameserv(n) Name service facility nameserv(n)
2______________________________________________________________________________
6
8 nameserv - Name service facility, Client
9
11 package require Tcl 8.4
12 package require nameserv ?0.4.2?
14 package require comm
16 package require logger
18 ::nameserv::bind name data
20 ::nameserv::release
22 ::nameserv::search ?-async|-continuous? ?pattern?
24 ::nameserv::protocol
26 ::nameserv::server_protocol
28 ::nameserv::server_features
30 ::nameserv::cget -option
32 ::nameserv::configure
34 ::nameserv::configure -option
36 ::nameserv::configure -option value...
38 $result destroy
40 $result filled
42 $result get name
44 $result names
46 $result size
48 $result getall ?pattern?
50______________________________________________________________________________
52
54 Please read Name service facility, introduction first.
55 This package provides a client for the name service facility imple‐
57 mented by the package nameserv::server.
58 This service is built in top of and for the package comm. It has noth‐
60 ing to do with the Internet's Domain Name System. If the reader is
61 looking for a package dealing with that please see Tcllib's packages
62 dns and resolv.
63
65 The package exports eight commands, as specified below:
66 ::nameserv::bind name data
68 The caller of this command registers the given name as its name
69 in the configured name service, and additionally associates a
70 piece of data with it. The service does nothing with this infor‐
71 mation beyond storing it and delivering it as part of search
72 results. The meaning is entirely up to the applications using
73 the name service.
74 A generally useful choice would for example be an identifier for
76 a communication endpoint managed by the package comm. Anybody
77 retrieving the name becomes immediately able to talk to this
78 endpoint, i.e. the registering application.
79 Of further importance is that a caller can register itself under
81 more than one name, and each name can have its own piece of
82 data.
83 Note that the name service, and thwerefore this command, will
85 throw an error if the chosen name is already registered.
86 ::nameserv::release
88 Invoking this command releases all names (and their data) regis‐
89 tered by all previous calls to ::nameserv::bind of this client.
90 Note that the name service will run this command implicitly when
91 it loses the connection to this client.
92 ::nameserv::search ?-async|-continuous? ?pattern?
94 This command searches the name service for all registered names
95 matching the specified glob-pattern. If not specified the pat‐
96 tern defaults to *, matching everything. The result of the com‐
97 mand is a dictionary mapping the matching names to the data
98 associated with them at bind-time.
99 If either option -async or -continuous were specified the result
101 of this command changes and becomes the Tcl command of an object
102 holding the actual result. These two options are supported if
103 and only if the service the client is connected to supports the
104 protocol feature Search/Continuous.
105 For -async the result object is asynchronously filled with the
107 entries matching the pattern at the time of the search and then
108 not modified any more. The option -continuous extends this be‐
109 haviour by additionally continuously monitoring the service for
110 the addition and removal of entries which match the pattern, and
111 updating the object's contents appropriately.
112 Note that the caller is responsible for configuring the object
114 with a callback for proper notification when the current result
115 (or further changes) arrive.
116 For more information about this object see section ASYNCHRONOUS
118 AND CONTINUOUS SEARCHES.
119 ::nameserv::protocol
121 This command returns the highest version of the name service
122 protocol supported by the package.
123 ::nameserv::server_protocol
125 This command returns the highest version of the name service
126 protocol supported by the name service the client is currently
127 connected to.
128 ::nameserv::server_features
130 This command returns a list containing the names of the features
131 of the name service protocol which are supported by the name
132 service the client is currently connected to.
133 ::nameserv::cget -option
135 This command returns the currently configured value for the
136 specified -option. The list of supported options and their mean‐
137 ing can be found in section OPTIONS.
138 ::nameserv::configure
140 In this form the command returns a dictionary of all supported
141 options, and their current values. The list of supported options
142 and their meaning can be found in section OPTIONS.
143 ::nameserv::configure -option
145 In this form the command is an alias for "::nameserv::cget
146 -option]". The list of supported options and their meaning can
147 be found in section OPTIONS.
148 ::nameserv::configure -option value...
150 In this form the command is used to configure one or more of the
151 supported options. At least one option has to be specified, and
152 each option is followed by its new value. The list of supported
153 options and their meaning can be found in section OPTIONS.
154 This form can be used only as long as the client has not con‐
156 tacted the name service yet. After contact has been made recon‐
157 figuration is not possible anymore. This means that this form of
158 the command is for the initalization of the client before it
159 use. The command forcing a contact with the name service are
160 bind
162 release
164 search
166 server_protocol
168 server_features
170
172 The client automatically connects to the service when one of the com‐
173 mands below is run for the first time, or whenever one of the commands
174 is run after the connection was lost, when it was lost.
175 bind
177 release
179 search
181 server_protocol
183 server_features
185 Since version 0.2 of the client it will generate an event when the con‐
187 nection is lost, allowing higher layers to perform additional actions.
188 This is done via the support package uevent. This and all other name
189 service related packages hereby reserve the uevent-tag nameserv. All
190 their events will be posted to that tag.
191
193 This package generates only one event, lost-connection. The detail
194 information provided to that event is a Tcl dictionary. The only key
195 contained in the dictionnary is reason, and its value will be a string
196 describing why the connection was lost. This string is supplied by the
197 underlying communication package, i.e. comm.
198
200 The options supported by the client are for the specification of which
201 name service to contact, i.e. of the location of the name service.
202 They are:
203 -host name|ipaddress
205 This option specifies the host name service to contact is run‐
206 ning on, either by name, or by ipaddress. The initial default is
207 localhost, i.e. it is expected to contact a name service running
208 on the same host as the application using this package.
209 -port number
211 This option specifies the port the name service to contact is
212 listening on. It has to be a positive integer number (> 0) not
213 greater than 65536 (unsigned short). The initial default is the
214 number returned by the command ::nameserv::common::port, as pro‐
215 vided by the package ::nameserv::common.
216
218 Asynchronous and continuous searches are invoked by using either option
219 -async or -continuous as argument to the command ::nameserv::search.
220 Note that these two options are supported if and only if the service
222 the client is connected to supports the protocol feature Search/Contin‐
223 uous. The service provided by the package ::nameserv::server does this
224 since version 0.3.
225 For such searches the result of the search command is the Tcl command
227 of an object holding the actual result. The API provided by these
228 objects is:
229 Options:
231 -command command_prefix
233 This option has to be set if a user of the result object
234 wishes to get asynchronous notifications when the search
235 result or changes to it arrive.
236 Note that while it is possible to poll for the arrival of
238 the initial search result via the method filled, and for
239 subsequent changes by comparing the output of method
240 getall against a saved copy, this is not the recommended
241 behaviour. Setting the -command callback and processing
242 the notifications as they arrive is much more efficient.
243 The command_prefix is called with two arguments, the type
245 of change, and the data of the change. The type is either
246 add or remove, indicating new data, or deleted data,
247 respectively. The data of the change is always a dictio‐
248 nary listing the added/removed names and their associated
249 data.
250 The first change reported for a search is always the set
252 of matching entries at the time of the search.
253 Methods:
255 $result destroy
257 Destroys the object and cancels any continuous monitoring
258 of the service the object may have had active.
259 $result filled
261 The result is a boolean value indicating whether the
262 search result has already arrived (True), or not (False).
263 $result get name
265 Returns the data associated with the given name at bind-
266 time.
267 $result names
269 Returns a list containing all names known to the object
270 at the time of the invokation.
271 $result size
273 Returns an integer value specifying the size of the
274 result at the time of the invokation.
275 $result getall ?pattern?
277 Returns a dictionary containing the search result at the
278 time of the invokation, mapping the matching names to the
279 data associated with them at bind-time.
280
282 0.3.1 Fixed SF Bug 1954771.
283 0.3 Extended the client with the ability to perform asynchronous and
285 continuous searches.
286 0.2 Extended the client with the ability to generate events when it
288 loses its connection to the name service. Based on package
289 uevent.
290 0.1 Initial implementation of the client.
292
294 This document, and the package it describes, will undoubtedly contain
295 bugs and other problems. Please report such in the category nameserv
296 of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
297 also report any ideas for enhancements you may have for either package
298 and/or documentation.
299 When proposing code changes, please provide unified diffs, i.e the out‐
301 put of diff -u.
302 Note further that attachments are strongly preferred over inlined
304 patches. Attachments can be made by going to the Edit form of the
305 ticket immediately after its creation, and then using the left-most
306 button in the secondary navigation bar.
307
309 nameserv::common(n), nameserv::server(n)
310
312 client, name service
313
315 Networking
316
318 Copyright (c) 2007-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>
319tcllib 0.4.2 nameserv(n)