GVirSandboxConsole

GVirSandboxConsole — A text mode console

Synopsis

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

#define             GVIR_SANDBOX_TYPE_CONSOLE_HANDLE
struct              GVirSandboxConsole;
struct              GVirSandboxConsoleClass;
gboolean            gvir_sandbox_console_attach_stdio   (GVirSandboxConsole *console,
                                                         GError **error);
gboolean            gvir_sandbox_console_attach_stderr  (GVirSandboxConsole *console,
                                                         GError **error);
gboolean            gvir_sandbox_console_attach         (GVirSandboxConsole *console,
                                                         GUnixInputStream *localStdin,
                                                         GUnixOutputStream *localStdout,
                                                         GUnixOutputStream *localStderr,
                                                         GError **error);
gboolean            gvir_sandbox_console_detach         (GVirSandboxConsole *console,
                                                         GError **error);
gboolean            gvir_sandbox_console_isolate        (GVirSandboxConsole *console,
                                                         GError **error);
void                gvir_sandbox_console_set_escape     (GVirSandboxConsole *console,
                                                         gchar escape);
gchar               gvir_sandbox_console_get_escape     (GVirSandboxConsole *console);
void                gvir_sandbox_console_set_direct     (GVirSandboxConsole *console,
                                                         gboolean direct);
gboolean            gvir_sandbox_console_get_direct     (GVirSandboxConsole *console);

Object Hierarchy

  GObject
   +----GVirSandboxConsole
         +----GVirSandboxConsoleRaw
         +----GVirSandboxConsoleRpc

Properties

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

Signals

  "closed"                                         : Run First

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.

Details

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];
};

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);

Property Details

The "connection" property

  "connection"               GVirConnection*       : Read / Write / Construct Only

The sandbox connection.


The "devname" property

  "devname"                  gchar*                : Read / Write / Construct Only

Device name.

Default value: NULL


The "direct" property

  "direct"                   gboolean              : Read / Write / Construct Only

Direct pty access.

Default value: FALSE


The "domain" property

  "domain"                   GVirDomain*           : Read / Write / Construct Only

The sandbox domain.


The "escape" property

  "escape"                   gchar                 : Read / Write / Construct Only

Escape character.

Allowed values: >= 0

Default value: 93

Signal Details

The "closed" signal

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