xref: /openbmc/qemu/include/io/channel-util.h (revision c767ae62b9efb2c9b2a757984ff1b14f89b49249)
1*c767ae62SDaniel P. Berrange /*
2*c767ae62SDaniel P. Berrange  * QEMU I/O channels utility APIs
3*c767ae62SDaniel P. Berrange  *
4*c767ae62SDaniel P. Berrange  * Copyright (c) 2016 Red Hat, Inc.
5*c767ae62SDaniel P. Berrange  *
6*c767ae62SDaniel P. Berrange  * This library is free software; you can redistribute it and/or
7*c767ae62SDaniel P. Berrange  * modify it under the terms of the GNU Lesser General Public
8*c767ae62SDaniel P. Berrange  * License as published by the Free Software Foundation; either
9*c767ae62SDaniel P. Berrange  * version 2 of the License, or (at your option) any later version.
10*c767ae62SDaniel P. Berrange  *
11*c767ae62SDaniel P. Berrange  * This library is distributed in the hope that it will be useful,
12*c767ae62SDaniel P. Berrange  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13*c767ae62SDaniel P. Berrange  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14*c767ae62SDaniel P. Berrange  * Lesser General Public License for more details.
15*c767ae62SDaniel P. Berrange  *
16*c767ae62SDaniel P. Berrange  * You should have received a copy of the GNU Lesser General Public
17*c767ae62SDaniel P. Berrange  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18*c767ae62SDaniel P. Berrange  *
19*c767ae62SDaniel P. Berrange  */
20*c767ae62SDaniel P. Berrange 
21*c767ae62SDaniel P. Berrange #ifndef QIO_CHANNEL_UTIL_H__
22*c767ae62SDaniel P. Berrange #define QIO_CHANNEL_UTIL_H__
23*c767ae62SDaniel P. Berrange 
24*c767ae62SDaniel P. Berrange #include "io/channel.h"
25*c767ae62SDaniel P. Berrange 
26*c767ae62SDaniel P. Berrange /*
27*c767ae62SDaniel P. Berrange  * This module provides helper functions that are useful when dealing
28*c767ae62SDaniel P. Berrange  * with QIOChannel objects
29*c767ae62SDaniel P. Berrange  */
30*c767ae62SDaniel P. Berrange 
31*c767ae62SDaniel P. Berrange 
32*c767ae62SDaniel P. Berrange /**
33*c767ae62SDaniel P. Berrange  * qio_channel_new_fd:
34*c767ae62SDaniel P. Berrange  * @fd: the file descriptor
35*c767ae62SDaniel P. Berrange  * @errp: pointer to a NULL-initialized error object
36*c767ae62SDaniel P. Berrange  *
37*c767ae62SDaniel P. Berrange  * Create a channel for performing I/O on the file
38*c767ae62SDaniel P. Berrange  * descriptor @fd. The particular subclass of QIOChannel
39*c767ae62SDaniel P. Berrange  * that is returned will depend on what underlying object
40*c767ae62SDaniel P. Berrange  * the file descriptor is associated with. It may be either
41*c767ae62SDaniel P. Berrange  * a QIOChannelSocket or a QIOChannelFile instance. Upon
42*c767ae62SDaniel P. Berrange  * success, the returned QIOChannel instance will own
43*c767ae62SDaniel P. Berrange  * the @fd file descriptor, and take responsibility for
44*c767ae62SDaniel P. Berrange  * closing it when no longer required. On failure, the
45*c767ae62SDaniel P. Berrange  * caller is responsible for closing @fd.
46*c767ae62SDaniel P. Berrange  *
47*c767ae62SDaniel P. Berrange  * Returns: the channel object, or NULL on error
48*c767ae62SDaniel P. Berrange  */
49*c767ae62SDaniel P. Berrange QIOChannel *qio_channel_new_fd(int fd,
50*c767ae62SDaniel P. Berrange                                Error **errp);
51*c767ae62SDaniel P. Berrange 
52*c767ae62SDaniel P. Berrange #endif /* QIO_CHANNEL_UTIL_H__ */
53