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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
|
#include <Python.h> // include first because it contains pre-processor defs
#ifndef WIN32
#include <sys/socket.h>
#include <sys/select.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#else
#include <winsock2.h>
#endif
#include "pylcm.h"
#include "pylcm_subscription.h"
#include "../lcm/dbg.h"
#ifndef Py_RETURN_NONE
#define Py_RETURN_NONE do { Py_INCREF( Py_None ); return Py_None; } while(0)
#endif
//#define dbg(...) fprintf (stderr, __VA_ARGS__)
//#define dbg(...)
// to support python 2.5 and earlier
#ifndef Py_TYPE
#define Py_TYPE(ob) (((PyObject*)(ob))->ob_type)
#endif
// to support python 3 where all ints are long
#if PY_MAJOR_VERSION >= 3
#define PyInt_FromLong PyLong_FromLong
#define PyInt_AsLong PyLong_AsLong
#endif
PyDoc_STRVAR (pylcm_doc,
"The LCM class provides a connection to an LCM network.\n\
\n\
usage::\n\
\n\
m = LCM ([provider])\n\
\n\
provider is a string specifying the LCM network to join. Since the Python \n\
LCM bindings are a wrapper around the C implementation, consult the C API\n\
documentation on how provider should be formatted. provider may be None or \n\
the empty string, in which case a default network is chosen.\n\
\n\
To subscribe to a channel::\n\
\n\
def msg_handler(channel, data):\n\
# message handling code here. For example:\n\
print(\"received %d byte message on %s\" % (len(data), channel))\n\
\n\
m.subscribe(channel, msg_handler)\n\
\n\
To transmit a raw binary string::\n\
\n\
m.publish(\"CHANNEL_NAME\", data)\n\
\n\
In general, LCM is used with python modules compiled by lcm-gen, each of \n\
which provides the instance method encode() and the static method decode().\n\
Thus, if one had a compiled type named example_t, the following message\n\
handler would decode the message::\n\
\n\
def msg_handler(channel, data):\n\
msg = example_t.decode(data)\n\
\n\
and the following usage would publish a message::\n\
\n\
msg = example_t()\n\
# ... set member variables of msg\n\
m.publish(\"CHANNEL_NAME\", msg.encode())\n\
\n\
@undocumented: __new__, __getattribute__\n\
");
//gives redefinition error in MSVC
//PyTypeObject pylcm_type;
// all LCM messages subscribed to by all LCM objects pass through this
// handler first.
static void
pylcm_msg_handler (const lcm_recv_buf_t *rbuf, const char *channel,
void *userdata)
{
PyLCMSubscriptionObject *subs_obj = (PyLCMSubscriptionObject*) userdata;
dbg(DBG_PYTHON, "%s %p %p\n", __FUNCTION__, subs_obj, subs_obj->lcm_obj);
// Restore the thread state before calling back into Python.
if (subs_obj->lcm_obj->saved_thread_state) {
PyEval_RestoreThread(subs_obj->lcm_obj->saved_thread_state);
subs_obj->lcm_obj->saved_thread_state = NULL;
}
// if an exception has occurred, then abort.
if (PyErr_Occurred ()) {
return;
}
#if PY_MAJOR_VERSION >= 3
PyObject *arglist = Py_BuildValue ("sy#", channel, // build from bytes
rbuf->data, rbuf->data_size);
#else
PyObject *arglist = Py_BuildValue ("ss#", channel, // build from string
rbuf->data, rbuf->data_size);
#endif
PyObject *result = PyEval_CallObject (subs_obj->handler, arglist);
Py_DECREF (arglist);
if (! result) {
subs_obj->lcm_obj->exception_raised = 1;
} else {
Py_DECREF (result);
}
}
// =============== LCM class methods ==============
static PyObject *
pylcm_subscribe (PyLCMObject *lcm_obj, PyObject *args)
{
char *channel = NULL;
int chan_len = 0;
PyObject *handler = NULL;
if (!PyArg_ParseTuple (args, "s#O", &channel, &chan_len, &handler))
return NULL;
if (!channel || ! chan_len) {
PyErr_SetString (PyExc_ValueError, "invalid channel");
return NULL;
}
if (!PyCallable_Check (handler)) {
PyErr_SetString (PyExc_ValueError, "handler is not callable");
return NULL;
}
PyLCMSubscriptionObject * subs_obj =
(PyLCMSubscriptionObject*) PyType_GenericNew (&pylcm_subscription_type,
NULL, NULL);
lcm_subscription_t *subscription =
lcm_subscribe (lcm_obj->lcm, channel, pylcm_msg_handler, subs_obj);
if (!subscription) {
Py_DECREF (subs_obj);
Py_RETURN_NONE;
}
subs_obj->subscription = subscription;
subs_obj->handler = handler;
Py_INCREF (handler);
subs_obj->lcm_obj = lcm_obj;
PyList_Append (lcm_obj->all_handlers, (PyObject*)subs_obj);
return (PyObject*)subs_obj;
}
PyDoc_STRVAR (pylcm_subscribe_doc,
"subscribe(channel, callback) -> L{LCMSubscription<lcm.LCMSubscription>}\n\
Registers a callback function to handle messages received on the specified\n\
channel.\n\
\n\
Multiple handlers can be registered for the same channel\n\
\n\
@param channel: LCM channel to subscribe to. Can also be a GLib/PCRE regular\n\
expression. Implicitly treated as the regex \"^channel$\"\n\
@param callback: Message handler, must accept two arguments.\n\
When a message is received, callback is invoked with two arguments\n\
corresponding to the actual channel on which the message was received, and \n\
a binary string containing the raw message bytes.\n\
");
static PyObject *
pylcm_unsubscribe (PyLCMObject *lcm_obj, PyObject *args)
{
dbg(DBG_PYTHON, "%s %p\n", __FUNCTION__, lcm_obj);
PyObject *_subs_obj = NULL;
if (!PyArg_ParseTuple (args, "O!", &pylcm_subscription_type,
&_subs_obj))
return NULL;
PyLCMSubscriptionObject *subs_obj = (PyLCMSubscriptionObject*) _subs_obj;
if (!subs_obj->subscription || subs_obj->lcm_obj != lcm_obj) {
PyErr_SetString (PyExc_ValueError, "Invalid Subscription object");
return NULL;
}
int subs_index = 0;
int nhandlers = PyList_Size (lcm_obj->all_handlers);
for (subs_index=0; subs_index<nhandlers; subs_index++) {
PyObject *so = PyList_GetItem (lcm_obj->all_handlers, subs_index);
if (so == (PyObject*) subs_obj) {
PySequence_DelItem (lcm_obj->all_handlers, subs_index);
break;
}
}
if (subs_index == nhandlers) {
PyErr_SetString (PyExc_ValueError, "Invalid Subscription object");
return NULL;
}
lcm_unsubscribe (lcm_obj->lcm, subs_obj->subscription);
subs_obj->subscription = NULL;
Py_DECREF (subs_obj->handler);
subs_obj->handler = NULL;
subs_obj->lcm_obj = NULL;
Py_RETURN_NONE;
}
PyDoc_STRVAR (pylcm_unsubscribe_doc,
"unsubscribe(subscription_object) -> None\n\
Unregisters a message handler so that it will no longer be invoked when\n\
a message on the specified channel is received\n\
\n\
@param subscription_object: An LCMSubscription object, as returned by a\n\
call to subscribe()\n\
");
static PyObject *
pylcm_publish (PyLCMObject *lcm_obj, PyObject *args)
{
char *data = NULL;
int datalen = 0;
char *channel = NULL;
if (!PyArg_ParseTuple (args, "ss#", &channel, &data, &datalen)) {
return NULL;
}
if (!channel || !strlen (channel)) {
PyErr_SetString (PyExc_ValueError, "invalid channel");
return NULL;
}
int status;
Py_BEGIN_ALLOW_THREADS
status = lcm_publish (lcm_obj->lcm, channel, (uint8_t*)data, datalen);
Py_END_ALLOW_THREADS
if (0 != status) {
PyErr_SetFromErrno (PyExc_IOError);
return NULL;
}
Py_RETURN_NONE;
}
PyDoc_STRVAR (pylcm_publish_doc,
"publish(channel, data) -> None\n\
Publishes a message to an LCM network\n\
\n\
@param channel: specifies the channel to which the message should be published.\n\
@param data: binary string containing the message to publish\n\
");
static PyObject *
pylcm_fileno (PyLCMObject *lcm_obj)
{
dbg(DBG_PYTHON, "%s %p\n", __FUNCTION__, lcm_obj);
return PyInt_FromLong (lcm_get_fileno (lcm_obj->lcm));
}
PyDoc_STRVAR (pylcm_fileno_doc,
"fileno() -> int\n\
\n\
Returns a file descriptor suitable for use with select, poll, etc.\n\
");
static PyObject *
pylcm_handle (PyLCMObject *lcm_obj)
{
dbg(DBG_PYTHON, "pylcm_handle(%p)\n", lcm_obj);
if (lcm_obj->saved_thread_state) {
PyErr_SetString (PyExc_RuntimeError,
"only one thread is allowed to call LCM.handle() or LCM.handle_timeout() at a time");
return NULL;
}
lcm_obj->saved_thread_state = PyEval_SaveThread();
lcm_obj->exception_raised = 0;
dbg(DBG_PYTHON, "calling lcm_handle(%p)\n", lcm_obj->lcm);
int status = lcm_handle (lcm_obj->lcm);
// Restore the thread state before returning back to Python. The thread
// state may have already been restored by the callback function
// pylcm_msg_handler()
if (lcm_obj->saved_thread_state) {
PyEval_RestoreThread(lcm_obj->saved_thread_state);
lcm_obj->saved_thread_state = NULL;
}
if (lcm_obj->exception_raised) { return NULL; }
if (status < 0) {
PyErr_SetString (PyExc_IOError, "lcm_handle() returned -1");
return NULL;
}
Py_RETURN_NONE;
}
PyDoc_STRVAR (pylcm_handle_doc,
"handle() -> None\n\
waits for and dispatches the next incoming message\n\
");
static PyObject *
pylcm_handle_timeout (PyLCMObject *lcm_obj, PyObject *arg)
{
int timeout_millis = PyInt_AsLong(arg);
if (timeout_millis == -1 && PyErr_Occurred())
return NULL;
if (timeout_millis < 0) {
PyErr_SetString (PyExc_ValueError, "invalid timeout");
return NULL;
}
dbg(DBG_PYTHON, "pylcm_handle_timeout(%p, %d)\n", lcm_obj, timeout_millis);
if (lcm_obj->saved_thread_state) {
PyErr_SetString (PyExc_RuntimeError,
"Simultaneous calls to handle() / handle_timeout() detected");
return NULL;
}
lcm_obj->saved_thread_state = PyEval_SaveThread();
lcm_obj->exception_raised = 0;
dbg(DBG_PYTHON, "calling lcm_handle_timeout(%p, %d)\n", lcm_obj->lcm,
timeout_millis);
int status = lcm_handle_timeout(lcm_obj->lcm, timeout_millis);
// Restore the thread state before returning back to Python. The thread
// state may have already been restored by the callback function
// pylcm_msg_handler()
if (lcm_obj->saved_thread_state) {
PyEval_RestoreThread(lcm_obj->saved_thread_state);
lcm_obj->saved_thread_state = NULL;
}
if (lcm_obj->exception_raised) { return NULL; }
if (status < 0) {
PyErr_SetString (PyExc_IOError, "lcm_handle_timeout() returned -1");
return NULL;
}
return PyInt_FromLong(status);
}
PyDoc_STRVAR (pylcm_handle_timeout_doc,
"handle_timeout(timeout_millis) -> int\n\
New in LCM 1.1.0\n\
\n\
waits for and dispatches the next incoming message, with a timeout.\n\
\n\
Raises ValueError if @p timeout_millis is invalid, or IOError if another\n\
error occurs.\n\
\n\
@param timeout_millis: the amount of time to wait, in milliseconds.\n\
@return 0 if the function timed out, >1 if a message was handled.\n\
");
static PyMethodDef pylcm_methods[] = {
{ "handle", (PyCFunction)pylcm_handle, METH_NOARGS, pylcm_handle_doc },
{ "handle_timeout", (PyCFunction)pylcm_handle_timeout, METH_O,
pylcm_handle_timeout_doc },
{ "subscribe", (PyCFunction)pylcm_subscribe, METH_VARARGS,
pylcm_subscribe_doc },
{ "unsubscribe", (PyCFunction)pylcm_unsubscribe, METH_VARARGS,
pylcm_unsubscribe_doc },
{ "publish", (PyCFunction)pylcm_publish, METH_VARARGS,
pylcm_publish_doc },
{ "fileno", (PyCFunction)pylcm_fileno, METH_NOARGS, pylcm_fileno_doc },
{ NULL, NULL }
};
// ==================== class administrative methods ====================
static PyObject *
pylcm_new (PyTypeObject *type, PyObject *args, PyObject *kwds)
{
PyObject *obj = type->tp_alloc (type, 0);
if (!obj) return NULL;
PyLCMObject *lcm_obj = (PyLCMObject*) obj;
lcm_obj->all_handlers = PyList_New (0);
if (!lcm_obj->all_handlers) {
Py_DECREF (obj);
return NULL;
}
return obj;
}
static void
pylcm_dealloc (PyLCMObject *lcm_obj)
{
dbg(DBG_PYTHON, "pylcm_dealloc\n");
if (lcm_obj->lcm) {
lcm_destroy (lcm_obj->lcm);
lcm_obj->lcm = NULL;
}
Py_DECREF (lcm_obj->all_handlers);
Py_TYPE (lcm_obj)->tp_free ((PyObject*)lcm_obj);
}
static int
pylcm_initobj (PyObject *self, PyObject *args, PyObject *kwargs)
{
dbg(DBG_PYTHON, "%s %p\n", __FUNCTION__, self);
PyLCMObject *lcm_obj = (PyLCMObject *)self;
char *url = NULL;
if (!PyArg_ParseTuple (args, "|s", &url))
return -1;
lcm_obj->lcm = lcm_create (url);
if (! lcm_obj->lcm) {
PyErr_SetString (PyExc_RuntimeError, "Couldn't create LCM");
return -1;
}
lcm_obj->saved_thread_state = NULL;
return 0;
}
/* Type object for socket objects. */
PyTypeObject pylcm_type = {
#if PY_MAJOR_VERSION >= 3
PyVarObject_HEAD_INIT (0, 0) /* size is now part of macro */
#else
PyObject_HEAD_INIT (0) /* Must fill in type value later */
0, /* ob_size */
#endif
"LCM", /* tp_name */
sizeof (PyLCMObject), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)pylcm_dealloc, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_compare */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
PyObject_GenericGetAttr, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
pylcm_doc, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
pylcm_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
pylcm_initobj, /* tp_init */
PyType_GenericAlloc, /* tp_alloc */
pylcm_new, /* tp_new */
PyObject_Del, /* tp_free */
};
|