GVirSandboxConsole

GVirSandboxConsole — A text mode console

Functions

Properties

GVirConnection * connection Read / Write / Construct Only
gchar * devname Read / Write / Construct Only
gboolean direct Read / Write / Construct Only
GVirDomain * domain Read / Write / Construct Only
gchar escape Read / Write / Construct Only

Signals

void closed Run First

Types and Values

Object Hierarchy

    GObject
    ╰── GVirSandboxConsole
        ├── GVirSandboxConsoleRaw
        ╰── GVirSandboxConsoleRpc

Includes

#include <libvirt-sandbox/libvirt-sandbox.h>

Description

Provides an object to interface to the text mode console of the sandbox

The GVirSandboxConsole object provides support for interfacing to the text mode console of the sandbox. It forwards I/O between the GVirStream associated with the virtual machine's console and a local console represented by GUnixInputStream and GUnixOutputStream objects.

Functions

gvir_sandbox_console_attach_stdio ()

gboolean
gvir_sandbox_console_attach_stdio (GVirSandboxConsole *console,
                                   GError **error);

gvir_sandbox_console_attach_stderr ()

gboolean
gvir_sandbox_console_attach_stderr (GVirSandboxConsole *console,
                                    GError **error);

gvir_sandbox_console_attach ()

gboolean
gvir_sandbox_console_attach (GVirSandboxConsole *console,
                             GUnixInputStream *localStdin,
                             GUnixOutputStream *localStdout,
                             GUnixOutputStream *localStderr,
                             GError **error);

gvir_sandbox_console_detach ()

gboolean
gvir_sandbox_console_detach (GVirSandboxConsole *console,
                             GError **error);

gvir_sandbox_console_isolate ()

gboolean
gvir_sandbox_console_isolate (GVirSandboxConsole *console,
                              GError **error);

gvir_sandbox_console_set_escape ()

void
gvir_sandbox_console_set_escape (GVirSandboxConsole *console,
                                 gchar escape);

gvir_sandbox_console_get_escape ()

gchar
gvir_sandbox_console_get_escape (GVirSandboxConsole *console);

gvir_sandbox_console_set_direct ()

void
gvir_sandbox_console_set_direct (GVirSandboxConsole *console,
                                 gboolean direct);

gvir_sandbox_console_get_direct ()

gboolean
gvir_sandbox_console_get_direct (GVirSandboxConsole *console);

Types and Values

GVIR_SANDBOX_TYPE_CONSOLE_HANDLE

#define GVIR_SANDBOX_TYPE_CONSOLE_HANDLE      (gvir_sandbox_console_handle_get_type ())

struct GVirSandboxConsole

struct GVirSandboxConsole;

struct GVirSandboxConsoleClass

struct GVirSandboxConsoleClass {
    GObjectClass parent_class;

    /* signals */
    void (*closed)(GVirSandboxConsole *console, gboolean err);

    /* class methods */
    gboolean (*attach)(GVirSandboxConsole *console,
                       GUnixInputStream *localStdin,
                       GUnixOutputStream *localStdout,
                       GUnixOutputStream *localStderr,
                       GError **error);
    gboolean (*detach)(GVirSandboxConsole *console,
                       GError **error);

    gpointer padding[LIBVIRT_SANDBOX_CLASS_PADDING];
};

GVirSandboxConsolePrivate

typedef struct _GVirSandboxConsolePrivate GVirSandboxConsolePrivate;

Property Details

The “connection” property

  “connection”               GVirConnection *

The sandbox connection.

Flags: Read / Write / Construct Only


The “devname” property

  “devname”                  gchar *

Device name.

Flags: Read / Write / Construct Only

Default value: NULL


The “direct” property

  “direct”                   gboolean

Direct pty access.

Flags: Read / Write / Construct Only

Default value: FALSE


The “domain” property

  “domain”                   GVirDomain *

The sandbox domain.

Flags: Read / Write / Construct Only


The “escape” property

  “escape”                   gchar

Escape character.

Flags: Read / Write / Construct Only

Allowed values: >= 0

Default value: 93

Signal Details

The “closed” signal

void
user_function (GVirSandboxConsole *gvirsandboxconsole,
               gboolean            arg1,
               gpointer            user_data)

Flags: Run First