]> sigrok.org Git - libsigrok.git/blob - session.c
Add a void *cb_data parameter to datafeed callbacks.
[libsigrok.git] / session.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <unistd.h>
23 #include <string.h>
24 #include <glib.h>
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
27
28 /* Message logging helpers with driver-specific prefix string. */
29 #define DRIVER_LOG_DOMAIN "session: "
30 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
31 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
32 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
33 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
34 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
35 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
36
37 /**
38  * @file
39  *
40  * Creating, using, or destroying libsigrok sessions.
41  */
42
43 /**
44  * @defgroup grp_session Session handling
45  *
46  * Creating, using, or destroying libsigrok sessions.
47  *
48  * @{
49  */
50
51 struct source {
52         int timeout;
53         sr_receive_data_callback_t cb;
54         void *cb_data;
55
56         /* This is used to keep track of the object (fd, pollfd or channel) which is
57          * being polled and will be used to match the source when removing it again.
58          */
59         gintptr poll_object;
60 };
61
62 struct datafeed_callback {
63         sr_datafeed_callback_t cb;
64         void *cb_data;
65 };
66
67 /* There can only be one session at a time. */
68 /* 'session' is not static, it's used elsewhere (via 'extern'). */
69 struct sr_session *session;
70
71 /**
72  * Create a new session.
73  *
74  * @todo Should it use the file-global "session" variable or take an argument?
75  *       The same question applies to all the other session functions.
76  *
77  * @return A pointer to the newly allocated session, or NULL upon errors.
78  */
79 SR_API struct sr_session *sr_session_new(void)
80 {
81         if (!(session = g_try_malloc0(sizeof(struct sr_session)))) {
82                 sr_err("Session malloc failed.");
83                 return NULL;
84         }
85
86         session->source_timeout = -1;
87         session->abort_session = FALSE;
88         g_mutex_init(&session->stop_mutex);
89
90         return session;
91 }
92
93 /**
94  * Destroy the current session.
95  *
96  * This frees up all memory used by the session.
97  *
98  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
99  */
100 SR_API int sr_session_destroy(void)
101 {
102         if (!session) {
103                 sr_err("%s: session was NULL", __func__);
104                 return SR_ERR_BUG;
105         }
106
107         sr_session_dev_remove_all();
108
109         /* TODO: Error checks needed? */
110
111         g_mutex_clear(&session->stop_mutex);
112
113         g_free(session);
114         session = NULL;
115
116         return SR_OK;
117 }
118
119 /**
120  * Close a device instance.
121  *
122  * @param sdi The device instance to close. Must not be NULL. Also,
123  *            sdi->driver, sdi->driver->priv, and sdi->priv must not be NULL.
124  */
125 static void sr_dev_close(struct sr_dev_inst *sdi)
126 {
127         int ret;
128
129         if (!sdi) {
130                 sr_err("Invalid device instance, can't close device.");
131                 return;
132         }
133
134         /* In the drivers sdi->priv is a 'struct dev_context *devc'. */
135         if (!sdi->priv) {
136                 /*
137                  * Should be sr_err() in theory, but the 'demo' driver has
138                  * NULL for sdi->priv, so we use sr_dbg() until that's fixed.
139                  */
140                 sr_dbg("Invalid device context, can't close device.");
141                 return;
142         }
143
144         if (!sdi->driver) {
145                 sr_err("Invalid driver, can't close device.");
146                 return;
147         }
148
149         if (!sdi->driver->priv) {
150                 sr_err("Driver not initialized, can't close device.");
151                 return;
152         }
153
154         sr_spew("Closing '%s' device instance %d.", sdi->driver->name,
155                 sdi->index);
156
157         if ((ret = sdi->driver->dev_close(sdi)) < 0)
158                 sr_err("Failed to close device instance: %d.", ret);
159 }
160
161 /**
162  * Remove all the devices from the current session.
163  *
164  * The session itself (i.e., the struct sr_session) is not free'd and still
165  * exists after this function returns.
166  *
167  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
168  */
169 SR_API int sr_session_dev_remove_all(void)
170 {
171         if (!session) {
172                 sr_err("%s: session was NULL", __func__);
173                 return SR_ERR_BUG;
174         }
175
176         g_slist_free_full(session->devs, (GDestroyNotify)sr_dev_close);
177         session->devs = NULL;
178
179         return SR_OK;
180 }
181
182 /**
183  * Add a device instance to the current session.
184  *
185  * @param sdi The device instance to add to the current session. Must not
186  *            be NULL. Also, sdi->driver and sdi->driver->dev_open must
187  *            not be NULL.
188  *
189  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
190  */
191 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
192 {
193         int ret;
194
195         if (!sdi) {
196                 sr_err("%s: sdi was NULL", __func__);
197                 return SR_ERR_ARG;
198         }
199
200         if (!session) {
201                 sr_err("%s: session was NULL", __func__);
202                 return SR_ERR_BUG;
203         }
204
205         /* If sdi->driver is NULL, this is a virtual device. */
206         if (!sdi->driver) {
207                 sr_dbg("%s: sdi->driver was NULL, this seems to be "
208                        "a virtual device; continuing", __func__);
209                 /* Just add the device, don't run dev_open(). */
210                 session->devs = g_slist_append(session->devs, (gpointer)sdi);
211                 return SR_OK;
212         }
213
214         /* sdi->driver is non-NULL (i.e. we have a real device). */
215         if (!sdi->driver->dev_open) {
216                 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
217                 return SR_ERR_BUG;
218         }
219
220         if ((ret = sdi->driver->dev_open((struct sr_dev_inst *)sdi)) != SR_OK) {
221                 sr_err("%s: dev_open failed (%d)", __func__, ret);
222                 return ret;
223         }
224
225         session->devs = g_slist_append(session->devs, (gpointer)sdi);
226
227         return SR_OK;
228 }
229
230 /**
231  * Remove all datafeed callbacks in the current session.
232  *
233  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
234  */
235 SR_API int sr_session_datafeed_callback_remove_all(void)
236 {
237         if (!session) {
238                 sr_err("%s: session was NULL", __func__);
239                 return SR_ERR_BUG;
240         }
241
242         g_slist_free_full(session->datafeed_callbacks, g_free);
243         session->datafeed_callbacks = NULL;
244
245         return SR_OK;
246 }
247
248 /**
249  * Add a datafeed callback to the current session.
250  *
251  * @param cb Function to call when a chunk of data is received.
252  *           Must not be NULL.
253  *
254  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
255  */
256 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
257 {
258         struct datafeed_callback *cb_struct;
259
260         if (!session) {
261                 sr_err("%s: session was NULL", __func__);
262                 return SR_ERR_BUG;
263         }
264
265         if (!cb) {
266                 sr_err("%s: cb was NULL", __func__);
267                 return SR_ERR_ARG;
268         }
269
270         if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback))))
271                 return SR_ERR_MALLOC;
272
273         cb_struct->cb = cb;
274         cb_struct->cb_data = cb_data;
275
276         session->datafeed_callbacks =
277             g_slist_append(session->datafeed_callbacks, cb_struct);
278
279         return SR_OK;
280 }
281
282 static int sr_session_run_poll(void)
283 {
284         unsigned int i;
285         int ret;
286
287         while (session->num_sources > 0) {
288                 ret = g_poll(session->pollfds, session->num_sources,
289                                 session->source_timeout);
290                 for (i = 0; i < session->num_sources; i++) {
291                         if (session->pollfds[i].revents > 0 || (ret == 0
292                                 && session->source_timeout == session->sources[i].timeout)) {
293                                 /*
294                                  * Invoke the source's callback on an event,
295                                  * or if the poll timed out and this source
296                                  * asked for that timeout.
297                                  */
298                                 if (!session->sources[i].cb(session->pollfds[i].fd,
299                                                 session->pollfds[i].revents,
300                                                 session->sources[i].cb_data))
301                                         sr_session_source_remove(session->sources[i].poll_object);
302                         }
303                         /*
304                          * We want to take as little time as possible to stop
305                          * the session if we have been told to do so. Therefore,
306                          * we check the flag after processing every source, not
307                          * just once per main event loop.
308                          */
309                         g_mutex_lock(&session->stop_mutex);
310                         if (session->abort_session)
311                                 sr_session_stop_sync();
312                         g_mutex_unlock(&session->stop_mutex);
313                 }
314         }
315
316         return SR_OK;
317 }
318
319 /**
320  * Start a session.
321  *
322  * There can only be one session at a time.
323  *
324  * @return SR_OK upon success, SR_ERR upon errors.
325  */
326 SR_API int sr_session_start(void)
327 {
328         struct sr_dev_inst *sdi;
329         GSList *l;
330         int ret;
331
332         if (!session) {
333                 sr_err("%s: session was NULL; a session must be "
334                        "created before starting it.", __func__);
335                 return SR_ERR_BUG;
336         }
337
338         if (!session->devs) {
339                 sr_err("%s: session->devs was NULL; a session "
340                        "cannot be started without devices.", __func__);
341                 return SR_ERR_BUG;
342         }
343
344         sr_info("Starting.");
345
346         ret = SR_OK;
347         for (l = session->devs; l; l = l->next) {
348                 sdi = l->data;
349                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
350                         sr_err("%s: could not start an acquisition "
351                                "(%d)", __func__, ret);
352                         break;
353                 }
354         }
355
356         /* TODO: What if there are multiple devices? Which return code? */
357
358         return ret;
359 }
360
361 /**
362  * Run the session.
363  *
364  * @return SR_OK upon success, SR_ERR_BUG upon errors.
365  */
366 SR_API int sr_session_run(void)
367 {
368         if (!session) {
369                 sr_err("%s: session was NULL; a session must be "
370                        "created first, before running it.", __func__);
371                 return SR_ERR_BUG;
372         }
373
374         if (!session->devs) {
375                 /* TODO: Actually the case? */
376                 sr_err("%s: session->devs was NULL; a session "
377                        "cannot be run without devices.", __func__);
378                 return SR_ERR_BUG;
379         }
380
381         sr_info("Running.");
382
383         /* Do we have real sources? */
384         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
385                 /* Dummy source, freewheel over it. */
386                 while (session->num_sources)
387                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
388         } else {
389                 /* Real sources, use g_poll() main loop. */
390                 sr_session_run_poll();
391         }
392
393         return SR_OK;
394 }
395
396 /**
397  * Stop the current session.
398  *
399  * The current session is stopped immediately, with all acquisition sessions
400  * being stopped and hardware drivers cleaned up.
401  *
402  * This must be called from within the session thread, to prevent freeing
403  * resources that the session thread will try to use.
404  *
405  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
406  */
407 SR_PRIV int sr_session_stop_sync(void)
408 {
409         struct sr_dev_inst *sdi;
410         GSList *l;
411
412         if (!session) {
413                 sr_err("%s: session was NULL", __func__);
414                 return SR_ERR_BUG;
415         }
416
417         sr_info("Stopping.");
418
419         for (l = session->devs; l; l = l->next) {
420                 sdi = l->data;
421                 if (sdi->driver) {
422                         if (sdi->driver->dev_acquisition_stop)
423                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
424                 }
425         }
426
427         /*
428          * Some sources may not be necessarily associated with a device.
429          * Those sources may still be present even after stopping all devices.
430          * We need to make sure all sources are removed, or we risk running the
431          * session in an infinite loop.
432          */
433         while (session->num_sources)
434                 sr_session_source_remove(session->sources[0].poll_object);
435
436         return SR_OK;
437 }
438
439 /**
440  * Stop the current session.
441  *
442  * The current session is stopped immediately, with all acquisition sessions
443  * being stopped and hardware drivers cleaned up.
444  *
445  * If the session is run in a separate thread, this function will not block
446  * until the session is finished executing. It is the caller's responsibility
447  * to wait for the session thread to return before assuming that the session is
448  * completely decommissioned.
449  *
450  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
451  */
452 SR_API int sr_session_stop(void)
453 {
454         if (!session) {
455                 sr_err("%s: session was NULL", __func__);
456                 return SR_ERR_BUG;
457         }
458
459         g_mutex_lock(&session->stop_mutex);
460         session->abort_session = TRUE;
461         g_mutex_unlock(&session->stop_mutex);
462
463         return SR_OK;
464 }
465
466 /**
467  * Debug helper.
468  *
469  * @param packet The packet to show debugging information for.
470  */
471 static void datafeed_dump(const struct sr_datafeed_packet *packet)
472 {
473         const struct sr_datafeed_logic *logic;
474         const struct sr_datafeed_analog *analog;
475
476         switch (packet->type) {
477         case SR_DF_HEADER:
478                 sr_dbg("bus: Received SR_DF_HEADER packet.");
479                 break;
480         case SR_DF_TRIGGER:
481                 sr_dbg("bus: Received SR_DF_TRIGGER packet.");
482                 break;
483         case SR_DF_META:
484                 sr_dbg("bus: Received SR_DF_META packet.");
485                 break;
486         case SR_DF_LOGIC:
487                 logic = packet->payload;
488                 sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
489                        logic->length);
490                 break;
491         case SR_DF_ANALOG:
492                 analog = packet->payload;
493                 sr_dbg("bus: Received SR_DF_ANALOG packet (%d samples).",
494                        analog->num_samples);
495                 break;
496         case SR_DF_END:
497                 sr_dbg("bus: Received SR_DF_END packet.");
498                 break;
499         case SR_DF_FRAME_BEGIN:
500                 sr_dbg("bus: Received SR_DF_FRAME_BEGIN packet.");
501                 break;
502         case SR_DF_FRAME_END:
503                 sr_dbg("bus: Received SR_DF_FRAME_END packet.");
504                 break;
505         default:
506                 sr_dbg("bus: Received unknown packet type: %d.", packet->type);
507                 break;
508         }
509 }
510
511 /**
512  * Send a packet to whatever is listening on the datafeed bus.
513  *
514  * Hardware drivers use this to send a data packet to the frontend.
515  *
516  * @param sdi TODO.
517  * @param packet The datafeed packet to send to the session bus.
518  *
519  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
520  *
521  * @private
522  */
523 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
524                             const struct sr_datafeed_packet *packet)
525 {
526         GSList *l;
527         struct datafeed_callback *cb_struct;
528
529         if (!sdi) {
530                 sr_err("%s: sdi was NULL", __func__);
531                 return SR_ERR_ARG;
532         }
533
534         if (!packet) {
535                 sr_err("%s: packet was NULL", __func__);
536                 return SR_ERR_ARG;
537         }
538
539         for (l = session->datafeed_callbacks; l; l = l->next) {
540                 if (sr_log_loglevel_get() >= SR_LOG_DBG)
541                         datafeed_dump(packet);
542                 cb_struct = l->data;
543                 cb_struct->cb(sdi, packet, cb_struct->cb_data);
544         }
545
546         return SR_OK;
547 }
548
549 /**
550  * Add an event source for a file descriptor.
551  *
552  * @param pollfd The GPollFD.
553  * @param timeout Max time to wait before the callback is called, ignored if 0.
554  * @param cb Callback function to add. Must not be NULL.
555  * @param cb_data Data for the callback function. Can be NULL.
556  * @param poll_object TODO.
557  *
558  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
559  *         SR_ERR_MALLOC upon memory allocation errors.
560  */
561 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
562         sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
563 {
564         struct source *new_sources, *s;
565         GPollFD *new_pollfds;
566
567         if (!cb) {
568                 sr_err("%s: cb was NULL", __func__);
569                 return SR_ERR_ARG;
570         }
571
572         /* Note: cb_data can be NULL, that's not a bug. */
573
574         new_pollfds = g_try_realloc(session->pollfds,
575                         sizeof(GPollFD) * (session->num_sources + 1));
576         if (!new_pollfds) {
577                 sr_err("%s: new_pollfds malloc failed", __func__);
578                 return SR_ERR_MALLOC;
579         }
580
581         new_sources = g_try_realloc(session->sources, sizeof(struct source) *
582                         (session->num_sources + 1));
583         if (!new_sources) {
584                 sr_err("%s: new_sources malloc failed", __func__);
585                 return SR_ERR_MALLOC;
586         }
587
588         new_pollfds[session->num_sources] = *pollfd;
589         s = &new_sources[session->num_sources++];
590         s->timeout = timeout;
591         s->cb = cb;
592         s->cb_data = cb_data;
593         s->poll_object = poll_object;
594         session->pollfds = new_pollfds;
595         session->sources = new_sources;
596
597         if (timeout != session->source_timeout && timeout > 0
598             && (session->source_timeout == -1 || timeout < session->source_timeout))
599                 session->source_timeout = timeout;
600
601         return SR_OK;
602 }
603
604 /**
605  * Add an event source for a file descriptor.
606  *
607  * @param fd The file descriptor.
608  * @param events Events to check for.
609  * @param timeout Max time to wait before the callback is called, ignored if 0.
610  * @param cb Callback function to add. Must not be NULL.
611  * @param cb_data Data for the callback function. Can be NULL.
612  *
613  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
614  *         SR_ERR_MALLOC upon memory allocation errors.
615  */
616 SR_API int sr_session_source_add(int fd, int events, int timeout,
617                 sr_receive_data_callback_t cb, void *cb_data)
618 {
619         GPollFD p;
620
621         p.fd = fd;
622         p.events = events;
623
624         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)fd);
625 }
626
627 /**
628  * Add an event source for a GPollFD.
629  *
630  * @param pollfd The GPollFD.
631  * @param timeout Max time to wait before the callback is called, ignored if 0.
632  * @param cb Callback function to add. Must not be NULL.
633  * @param cb_data Data for the callback function. Can be NULL.
634  *
635  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
636  *         SR_ERR_MALLOC upon memory allocation errors.
637  */
638 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
639                 sr_receive_data_callback_t cb, void *cb_data)
640 {
641         return _sr_session_source_add(pollfd, timeout, cb,
642                                       cb_data, (gintptr)pollfd);
643 }
644
645 /**
646  * Add an event source for a GIOChannel.
647  *
648  * @param channel The GIOChannel.
649  * @param events Events to poll on.
650  * @param timeout Max time to wait before the callback is called, ignored if 0.
651  * @param cb Callback function to add. Must not be NULL.
652  * @param cb_data Data for the callback function. Can be NULL.
653  *
654  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
655  *         SR_ERR_MALLOC upon memory allocation errors.
656  */
657 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
658                 int timeout, sr_receive_data_callback_t cb, void *cb_data)
659 {
660         GPollFD p;
661
662 #ifdef _WIN32
663         g_io_channel_win32_make_pollfd(channel, events, &p);
664 #else
665         p.fd = g_io_channel_unix_get_fd(channel);
666         p.events = events;
667 #endif
668
669         return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel);
670 }
671
672 /**
673  * Remove the source belonging to the specified channel.
674  *
675  * @todo Add more error checks and logging.
676  *
677  * @param channel The channel for which the source should be removed.
678  *
679  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
680  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
681  *         internal errors.
682  */
683 static int _sr_session_source_remove(gintptr poll_object)
684 {
685         struct source *new_sources;
686         GPollFD *new_pollfds;
687         unsigned int old;
688
689         if (!session->sources || !session->num_sources) {
690                 sr_err("%s: sources was NULL", __func__);
691                 return SR_ERR_BUG;
692         }
693
694         for (old = 0; old < session->num_sources; old++) {
695                 if (session->sources[old].poll_object == poll_object)
696                         break;
697         }
698
699         /* fd not found, nothing to do */
700         if (old == session->num_sources)
701                 return SR_OK;
702
703         session->num_sources -= 1;
704
705         if (old != session->num_sources) {
706                 memmove(&session->pollfds[old], &session->pollfds[old+1],
707                         (session->num_sources - old) * sizeof(GPollFD));
708                 memmove(&session->sources[old], &session->sources[old+1],
709                         (session->num_sources - old) * sizeof(struct source));
710         }
711
712         new_pollfds = g_try_realloc(session->pollfds, sizeof(GPollFD) * session->num_sources);
713         if (!new_pollfds && session->num_sources > 0) {
714                 sr_err("%s: new_pollfds malloc failed", __func__);
715                 return SR_ERR_MALLOC;
716         }
717
718         new_sources = g_try_realloc(session->sources, sizeof(struct source) * session->num_sources);
719         if (!new_sources && session->num_sources > 0) {
720                 sr_err("%s: new_sources malloc failed", __func__);
721                 return SR_ERR_MALLOC;
722         }
723
724         session->pollfds = new_pollfds;
725         session->sources = new_sources;
726
727         return SR_OK;
728 }
729
730 /**
731  * Remove the source belonging to the specified file descriptor.
732  *
733  * @param fd The file descriptor for which the source should be removed.
734  *
735  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
736  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
737  *         internal errors.
738  */
739 SR_API int sr_session_source_remove(int fd)
740 {
741         return _sr_session_source_remove((gintptr)fd);
742 }
743
744 /**
745  * Remove the source belonging to the specified poll descriptor.
746  *
747  * @param pollfd The poll descriptor for which the source should be removed.
748  *
749  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
750  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
751  *         internal errors.
752  */
753 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
754 {
755         return _sr_session_source_remove((gintptr)pollfd);
756 }
757
758 /**
759  * Remove the source belonging to the specified channel.
760  *
761  * @param channel The channel for which the source should be removed.
762  *
763  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
764  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
765  *         internal errors.
766  */
767 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
768 {
769         return _sr_session_source_remove((gintptr)channel);
770 }
771
772 /** @} */