org.libvirt

Class Stream

public class Stream extends Object

Field Summary
protected Libvirtlibvirt
The libvirt connection from the hypervisor
static intVIR_STREAM_NONBLOCK
Method Summary
intabort()
Request that the in progress data transfer be cancelled abnormally before the end of the stream has been reached
intaddCallback(int events, Libvirt.VirStreamEventCallback cb)
Register a callback to be notified when a stream becomes writable, or readable.
intfinish()
Indicate that there is no further data is to be transmitted on the stream.
intfree()
Decrement the reference count on a stream, releasing the stream object if the reference count has hit zero.
protected voidprocessError()
Error handling logic to throw errors.
intreceive(byte[] data)
Receieves data from teh stream into the buffer provided.
intreceiveAll(Libvirt.VirStreamSinkFunc handler)
Batch receive method
intremoveCallback()
Remove an event callback from the stream
intsend(String data)
Write a series of bytes to the stream.
intsendAll(Libvirt.VirStreamSourceFunc handler)
Batch send method
intupdateCallback(int events)
Changes the set of events to monitor for a stream.

Field Detail

libvirt

protected Libvirt libvirt
The libvirt connection from the hypervisor

VIR_STREAM_NONBLOCK

public static int VIR_STREAM_NONBLOCK

Method Detail

abort

public int abort()
Request that the in progress data transfer be cancelled abnormally before the end of the stream has been reached

addCallback

public int addCallback(int events, Libvirt.VirStreamEventCallback cb)
Register a callback to be notified when a stream becomes writable, or readable.

Parameters: events the events to monitor cb the callback method

Returns: 0 for success, -1 for failure

Throws: LibvirtException

See Also: Libvirt Docs

finish

public int finish()
Indicate that there is no further data is to be transmitted on the stream.

Returns: 0 if success, -1 if failure

Throws: LibvirtException

free

public int free()
Decrement the reference count on a stream, releasing the stream object if the reference count has hit zero.

Returns: 0 on success, or -1 on error.

Throws: LibvirtException

processError

protected void processError()
Error handling logic to throw errors. Must be called after every libvirt call.

receive

public int receive(byte[] data)
Receieves data from teh stream into the buffer provided.

Parameters: data the put the sata into

Returns: the number of bytes read, -1 on error, -2 if the buffer is empty

Throws: LibvirtException

receiveAll

public int receiveAll(Libvirt.VirStreamSinkFunc handler)
Batch receive method

Parameters: handler the callback handler

Returns: 0 if successfule, -1 otherwise

Throws: LibvirtException

See Also: http://www.libvirt.org/html/libvirt-libvirt.html#virStreamRecvAll

removeCallback

public int removeCallback()
Remove an event callback from the stream

Returns: 0 for success, -1 for failure

Throws: LibvirtException

See Also: Libvirt Docs

send

public int send(String data)
Write a series of bytes to the stream.

Parameters: data the data to write

Returns: the number of bytes written, -1 on error, -2 if the buffer is full

Throws: LibvirtException

sendAll

public int sendAll(Libvirt.VirStreamSourceFunc handler)
Batch send method

Parameters: handler the callback handler

Returns: 0 if successfule, -1 otherwise

Throws: LibvirtException

See Also: Libvirt Documentation

updateCallback

public int updateCallback(int events)
Changes the set of events to monitor for a stream.

Parameters: events the events to monitor

Returns: 0 for success, -1 for failure

Throws: LibvirtException

See Also: Libvirt Docs