Package org.libvirt
Class Stream
java.lang.Object
org.libvirt.Stream
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Libvirt
The libvirt connection from the hypervisorstatic int
-
Method Summary
Modifier and TypeMethodDescriptionint
abort()
Request that the in progress data transfer be cancelled abnormally before the end of the stream has been reachedint
addCallback
(int events, Libvirt.VirStreamEventCallback cb) Register a callback to be notified when a stream becomes writable, or readable.void
finalize()
int
finish()
Indicate that there is no further data is to be transmitted on the stream.int
free()
Decrement the reference count on a stream, releasing the stream object if the reference count has hit zero.protected void
Error handling logic to throw errors.int
receive
(byte[] data) Receieves data from teh stream into the buffer provided.int
receiveAll
(Libvirt.VirStreamSinkFunc handler) Batch receive methodint
Remove an event callback from the streamint
Write a series of bytes to the stream.int
sendAll
(Libvirt.VirStreamSourceFunc handler) Batch send methodint
updateCallback
(int events) Changes the set of events to monitor for a stream.
-
Field Details
-
VIR_STREAM_NONBLOCK
public static int VIR_STREAM_NONBLOCK -
libvirt
The libvirt connection from the hypervisor
-
-
Method Details
-
abort
Request that the in progress data transfer be cancelled abnormally before the end of the stream has been reached- Throws:
LibvirtException
-
addCallback
Register a callback to be notified when a stream becomes writable, or readable.- Parameters:
events
- the events to monitorcb
- the callback method- Returns:
- 0 for success, -1 for failure
- Throws:
LibvirtException
- See Also:
-
finalize
- Overrides:
finalize
in classObject
- Throws:
LibvirtException
-
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
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
Error handling logic to throw errors. Must be called after every libvirt call.- Throws:
LibvirtException
-
receive
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
Batch receive method- Parameters:
handler
- the callback handler- Returns:
- 0 if successfule, -1 otherwise
- Throws:
LibvirtException
- See Also:
-
removeCallback
Remove an event callback from the stream- Returns:
- 0 for success, -1 for failure
- Throws:
LibvirtException
- See Also:
-
send
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
Batch send method- Parameters:
handler
- the callback handler- Returns:
- 0 if successfule, -1 otherwise
- Throws:
LibvirtException
- See Also:
-
updateCallback
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:
-