]> sigrok.org Git - libsigrok.git/blob - session.c
When adding a device instance to a running session, start acquisition on it
[libsigrok.git] / session.c
1 /*
2  * This file is part of the libsigrok 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 subsystem-specific prefix string. */
29 #define LOG_PREFIX "session: "
30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
35 #define sr_err(s, args...) sr_err(LOG_PREFIX 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->running = FALSE;
88         session->abort_session = FALSE;
89         g_mutex_init(&session->stop_mutex);
90
91         return session;
92 }
93
94 /**
95  * Destroy the current session.
96  *
97  * This frees up all memory used by the session.
98  *
99  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
100  */
101 SR_API int sr_session_destroy(void)
102 {
103         if (!session) {
104                 sr_err("%s: session was NULL", __func__);
105                 return SR_ERR_BUG;
106         }
107
108         sr_session_dev_remove_all();
109
110         /* TODO: Error checks needed? */
111
112         g_mutex_clear(&session->stop_mutex);
113
114         g_free(session);
115         session = NULL;
116
117         return SR_OK;
118 }
119
120 /**
121  * Remove all the devices from the current session.
122  *
123  * The session itself (i.e., the struct sr_session) is not free'd and still
124  * exists after this function returns.
125  *
126  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
127  */
128 SR_API int sr_session_dev_remove_all(void)
129 {
130         if (!session) {
131                 sr_err("%s: session was NULL", __func__);
132                 return SR_ERR_BUG;
133         }
134
135         g_slist_free(session->devs);
136         session->devs = NULL;
137
138         return SR_OK;
139 }
140
141 /**
142  * Add a device instance to the current session.
143  *
144  * @param sdi The device instance to add to the current session. Must not
145  *            be NULL. Also, sdi->driver and sdi->driver->dev_open must
146  *            not be NULL.
147  *
148  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
149  */
150 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
151 {
152         int ret;
153
154         if (!sdi) {
155                 sr_err("%s: sdi was NULL", __func__);
156                 return SR_ERR_ARG;
157         }
158
159         if (!session) {
160                 sr_err("%s: session was NULL", __func__);
161                 return SR_ERR_BUG;
162         }
163
164         /* If sdi->driver is NULL, this is a virtual device. */
165         if (!sdi->driver) {
166                 sr_dbg("%s: sdi->driver was NULL, this seems to be "
167                        "a virtual device; continuing", __func__);
168                 /* Just add the device, don't run dev_open(). */
169                 session->devs = g_slist_append(session->devs, (gpointer)sdi);
170                 return SR_OK;
171         }
172
173         /* sdi->driver is non-NULL (i.e. we have a real device). */
174         if (!sdi->driver->dev_open) {
175                 sr_err("%s: sdi->driver->dev_open was NULL", __func__);
176                 return SR_ERR_BUG;
177         }
178
179         session->devs = g_slist_append(session->devs, (gpointer)sdi);
180
181         if (session->running) {
182                 /* Adding a device to a running session. Start acquisition
183                  * on that device now. */
184                 if ((ret = sdi->driver->dev_acquisition_start(sdi,
185                                                 (void *)sdi)) != SR_OK)
186                         sr_err("Failed to start acquisition of device in "
187                                         "running session: %d", ret);
188         }
189
190         return SR_OK;
191 }
192
193 /**
194  * List all device instances attached to the current session.
195  *
196  * @param devlist A pointer where the device instance list will be
197  *                stored on return. If no devices are in the session,
198  *                this will be NULL. Each element in the list points
199  *                to a struct sr_dev_inst *.
200  *                The list must be freed by the caller, but not the
201  *                elements pointed to.
202  *
203  * @return SR_OK upon success, SR_ERR upon invalid arguments.
204  */
205 SR_API int sr_session_dev_list(GSList **devlist)
206 {
207
208         *devlist = NULL;
209
210         if (!session)
211                 return SR_ERR;
212
213         *devlist = g_slist_copy(session->devs);
214
215         return SR_OK;
216 }
217
218 /**
219  * Remove all datafeed callbacks in the current session.
220  *
221  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
222  */
223 SR_API int sr_session_datafeed_callback_remove_all(void)
224 {
225         if (!session) {
226                 sr_err("%s: session was NULL", __func__);
227                 return SR_ERR_BUG;
228         }
229
230         g_slist_free_full(session->datafeed_callbacks, g_free);
231         session->datafeed_callbacks = NULL;
232
233         return SR_OK;
234 }
235
236 /**
237  * Add a datafeed callback to the current session.
238  *
239  * @param cb Function to call when a chunk of data is received.
240  *           Must not be NULL.
241  * @param cb_data Opaque pointer passed in by the caller.
242  *
243  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
244  */
245 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
246 {
247         struct datafeed_callback *cb_struct;
248
249         if (!session) {
250                 sr_err("%s: session was NULL", __func__);
251                 return SR_ERR_BUG;
252         }
253
254         if (!cb) {
255                 sr_err("%s: cb was NULL", __func__);
256                 return SR_ERR_ARG;
257         }
258
259         if (!(cb_struct = g_try_malloc0(sizeof(struct datafeed_callback))))
260                 return SR_ERR_MALLOC;
261
262         cb_struct->cb = cb;
263         cb_struct->cb_data = cb_data;
264
265         session->datafeed_callbacks =
266             g_slist_append(session->datafeed_callbacks, cb_struct);
267
268         return SR_OK;
269 }
270
271 /**
272  * Call every device in the session's callback.
273  *
274  * For sessions not driven by select loops such as sr_session_run(),
275  * but driven by another scheduler, this can be used to poll the devices
276  * from within that scheduler.
277  *
278  * @param block If TRUE, this call will wait for any of the session's
279  *              sources to fire an event on the file descriptors, or
280  *              any of their timeouts to activate. In other words, this
281  *              can be used as a select loop.
282  *              If FALSE, all sources have their callback run, regardless
283  *              of file descriptor or timeout status.
284  *
285  * @return SR_OK upon success, SR_ERR on errors.
286  */
287 static int sr_session_iteration(gboolean block)
288 {
289         unsigned int i;
290         int ret;
291
292         ret = g_poll(session->pollfds, session->num_sources,
293                         block ? session->source_timeout : 0);
294         for (i = 0; i < session->num_sources; i++) {
295                 if (session->pollfds[i].revents > 0 || (ret == 0
296                         && session->source_timeout == session->sources[i].timeout)) {
297                         /*
298                          * Invoke the source's callback on an event,
299                          * or if the poll timed out and this source
300                          * asked for that timeout.
301                          */
302                         if (!session->sources[i].cb(session->pollfds[i].fd,
303                                         session->pollfds[i].revents,
304                                         session->sources[i].cb_data))
305                                 sr_session_source_remove(session->sources[i].poll_object);
306                 }
307                 /*
308                  * We want to take as little time as possible to stop
309                  * the session if we have been told to do so. Therefore,
310                  * we check the flag after processing every source, not
311                  * just once per main event loop.
312                  */
313                 g_mutex_lock(&session->stop_mutex);
314                 if (session->abort_session) {
315                         sr_session_stop_sync();
316                         /* But once is enough. */
317                         session->abort_session = FALSE;
318                 }
319                 g_mutex_unlock(&session->stop_mutex);
320         }
321
322         return SR_OK;
323 }
324
325 /**
326  * Start a session.
327  *
328  * There can only be one session at a time.
329  *
330  * @return SR_OK upon success, SR_ERR upon errors.
331  */
332 SR_API int sr_session_start(void)
333 {
334         struct sr_dev_inst *sdi;
335         GSList *l;
336         int ret;
337
338         if (!session) {
339                 sr_err("%s: session was NULL; a session must be "
340                        "created before starting it.", __func__);
341                 return SR_ERR_BUG;
342         }
343
344         if (!session->devs) {
345                 sr_err("%s: session->devs was NULL; a session "
346                        "cannot be started without devices.", __func__);
347                 return SR_ERR_BUG;
348         }
349
350         sr_info("Starting.");
351
352         ret = SR_OK;
353         for (l = session->devs; l; l = l->next) {
354                 sdi = l->data;
355                 if ((ret = sdi->driver->dev_acquisition_start(sdi, sdi)) != SR_OK) {
356                         sr_err("%s: could not start an acquisition "
357                                "(%d)", __func__, ret);
358                         break;
359                 }
360         }
361
362         /* TODO: What if there are multiple devices? Which return code? */
363
364         return ret;
365 }
366
367 /**
368  * Run the session.
369  *
370  * @return SR_OK upon success, SR_ERR_BUG upon errors.
371  */
372 SR_API int sr_session_run(void)
373 {
374         if (!session) {
375                 sr_err("%s: session was NULL; a session must be "
376                        "created first, before running it.", __func__);
377                 return SR_ERR_BUG;
378         }
379
380         if (!session->devs) {
381                 /* TODO: Actually the case? */
382                 sr_err("%s: session->devs was NULL; a session "
383                        "cannot be run without devices.", __func__);
384                 return SR_ERR_BUG;
385         }
386         session->running = TRUE;
387
388         sr_info("Running.");
389
390         /* Do we have real sources? */
391         if (session->num_sources == 1 && session->pollfds[0].fd == -1) {
392                 /* Dummy source, freewheel over it. */
393                 while (session->num_sources)
394                         session->sources[0].cb(-1, 0, session->sources[0].cb_data);
395         } else {
396                 /* Real sources, use g_poll() main loop. */
397                 while (session->num_sources)
398                         sr_session_iteration(TRUE);
399         }
400
401         return SR_OK;
402 }
403
404 /**
405  * Stop the current session.
406  *
407  * The current session is stopped immediately, with all acquisition sessions
408  * being stopped and hardware drivers cleaned up.
409  *
410  * This must be called from within the session thread, to prevent freeing
411  * resources that the session thread will try to use.
412  *
413  * @return SR_OK upon success, SR_ERR_BUG if no session exists.
414  */
415 SR_PRIV int sr_session_stop_sync(void)
416 {
417         struct sr_dev_inst *sdi;
418         GSList *l;
419
420         if (!session) {
421                 sr_err("%s: session was NULL", __func__);
422                 return SR_ERR_BUG;
423         }
424
425         sr_info("Stopping.");
426
427         for (l = session->devs; l; l = l->next) {
428                 sdi = l->data;
429                 if (sdi->driver) {
430                         if (sdi->driver->dev_acquisition_stop)
431                                 sdi->driver->dev_acquisition_stop(sdi, sdi);
432                 }
433         }
434         session->running = FALSE;
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 /** @} */