fwupd/libfwupdplugin/fu-io-channel.h
Richard Hughes 5c9b1fcc81 Only include the start year in the copyright header
The end year is legally and functionally redundant, and more importantly causes
cherry-pick conflicts when trying to maintain old branches. Use git for history.
2021-01-07 14:48:16 +00:00

81 lines
2.5 KiB
C

/*
* Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <glib-object.h>
#define FU_TYPE_IO_CHANNEL (fu_io_channel_get_type ())
G_DECLARE_FINAL_TYPE (FuIOChannel, fu_io_channel, FU, IO_CHANNEL, GObject)
/**
* FuIOChannelFlags:
* @FU_IO_CHANNEL_FLAG_NONE: No flags are set
* @FU_IO_CHANNEL_FLAG_SINGLE_SHOT: Only one read or write is expected
* @FU_IO_CHANNEL_FLAG_FLUSH_INPUT: Flush pending input before writing
* @FU_IO_CHANNEL_FLAG_USE_BLOCKING_IO: Block waiting for the TTY
*
* The flags used when reading data from the TTY.
**/
typedef enum {
FU_IO_CHANNEL_FLAG_NONE = 0, /* Since: 1.2.2 */
FU_IO_CHANNEL_FLAG_SINGLE_SHOT = 1 << 0, /* Since: 1.2.2 */
FU_IO_CHANNEL_FLAG_FLUSH_INPUT = 1 << 1, /* Since: 1.2.2 */
FU_IO_CHANNEL_FLAG_USE_BLOCKING_IO = 1 << 2, /* Since: 1.2.2 */
/*< private >*/
FU_IO_CHANNEL_FLAG_LAST
} FuIOChannelFlags;
FuIOChannel *fu_io_channel_unix_new (gint fd);
FuIOChannel *fu_io_channel_new_file (const gchar *filename,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
gint fu_io_channel_unix_get_fd (FuIOChannel *self);
gboolean fu_io_channel_shutdown (FuIOChannel *self,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
gboolean fu_io_channel_write_raw (FuIOChannel *self,
const guint8 *data,
gsize datasz,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
gboolean fu_io_channel_read_raw (FuIOChannel *self,
guint8 *buf,
gsize bufsz,
gsize *bytes_read,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
gboolean fu_io_channel_write_bytes (FuIOChannel *self,
GBytes *bytes,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
gboolean fu_io_channel_write_byte_array (FuIOChannel *self,
GByteArray *buf,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
GBytes *fu_io_channel_read_bytes (FuIOChannel *self,
gssize max_size,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;
GByteArray *fu_io_channel_read_byte_array (FuIOChannel *self,
gssize max_size,
guint timeout_ms,
FuIOChannelFlags flags,
GError **error)
G_GNUC_WARN_UNUSED_RESULT;