SpiceClientGLib.PortChannel

Subclasses:

SpiceClientGLib.WebdavChannel

Methods

Inherited:

SpiceClientGLib.Channel (13), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	event (event)
	write_async (buffer, cancellable, callback, *user_data)
	write_finish (result)

Virtual Methods

Inherited:

SpiceClientGLib.Channel (8), GObject.Object (7)

Properties

Inherited:

SpiceClientGLib.Channel (5)

Name	Type	Flags	Short Description
port-name	str	r	Port name
port-opened	bool	r	Port opened

Signals

Inherited:

SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Short Description
port-data	The SpiceClientGLib.PortChannel ::port-data signal is emitted when new port data is received.
port-event	The SpiceClientGLib.PortChannel ::port-event signal is emitted when new port event is received.

Fields

Inherited:

SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Type	Access	Description
parent	SpiceClientGLib.Channel	r

Class Details

class SpiceClientGLib.PortChannel(**kwargs)

Bases:

SpiceClientGLib.Channel

Abstract:

No

Structure:

SpiceClientGLib.PortChannelClass

The SpiceClientGLib.PortChannel struct is opaque and should not be accessed directly.

event(event)

Parameters:

event (int) – a SPICE_PORT_EVENT value

Send an event to the port.

Note: The values SPICE_PORT_EVENT_CLOSED and SPICE_PORT_EVENT_OPENED are managed by the channel connection state.

New in version 0.35.

write_async(buffer, cancellable, callback, *user_data)

Parameters:

• buffer (bytes) – the buffer containing the data to write

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, None to ignore

• callback (Gio.AsyncReadyCallback or None) – callback to call when the request is satisfied

• user_data (object or None) – the data to pass to callback function

Request an asynchronous write of count bytes from buffer into the self. When the operation is finished callback will be called. You can then call SpiceClientGLib.port_write_finish() to get the result of the operation.

New in version 0.35.

write_finish(result)

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

a #gssize containing the number of bytes written to the stream.

Return type:

int

Finishes a port write operation.

New in version 0.35.

Signal Details

SpiceClientGLib.PortChannel.signals.port_data(port_channel, data, size)

Signal Name:

port-data

Flags:

RUN_LAST

Parameters:

• port_channel (SpiceClientGLib.PortChannel) – The object which received the signal

• data (object or None) – the data received

• size (int) – number of bytes read

The SpiceClientGLib.PortChannel ::port-data signal is emitted when new port data is received.

New in version 0.15.

SpiceClientGLib.PortChannel.signals.port_event(port_channel, event)

Signal Name:

port-event

Flags:

RUN_LAST

Parameters:

• port_channel (SpiceClientGLib.PortChannel) – The object which received the signal

• event (int) – the event received

The SpiceClientGLib.PortChannel ::port-event signal is emitted when new port event is received.

New in version 0.15.

Property Details

SpiceClientGLib.PortChannel.props.port_name

Name:

port-name

Type:

str

Default Value:

None

Flags:

READABLE

Port name

SpiceClientGLib.PortChannel.props.port_opened

Name:

port-opened

Type:

bool

Default Value:

False

Flags:

READABLE

Port opened