org.libvirt
Class Stream

java.lang.Object
  extended by org.libvirt.Stream

public class Stream
extends java.lang.Object


Field Summary
protected  Libvirt libvirt
          The libvirt connection from the hypervisor
static int VIR_STREAM_NONBLOCK
           
 
Method Summary
 int abort()
          Request that the in progress data transfer be cancelled abnormally before the end of the stream has been reached
 int 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 processError()
          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 method
 int removeCallback()
          Remove an event callback from the stream
 int send(java.lang.String data)
          Write a series of bytes to the stream.
 int sendAll(Libvirt.VirStreamSourceFunc handler)
          Batch send method
 int updateCallback(int events)
          Changes the set of events to monitor for a stream.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VIR_STREAM_NONBLOCK

public static int VIR_STREAM_NONBLOCK

libvirt

protected Libvirt libvirt
The libvirt connection from the hypervisor

Method Detail

abort

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

Throws:
LibvirtException

addCallback

public int addCallback(int events,
                       Libvirt.VirStreamEventCallback cb)
                throws LibvirtException
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

finalize

public void finalize()
              throws LibvirtException
Overrides:
finalize in class java.lang.Object
Throws:
LibvirtException

finish

public int finish()
           throws LibvirtException
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()
         throws LibvirtException
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()
                     throws LibvirtException
Error handling logic to throw errors. Must be called after every libvirt call.

Throws:
LibvirtException

receive

public int receive(byte[] data)
            throws LibvirtException
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)
               throws LibvirtException
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()
                   throws LibvirtException
Remove an event callback from the stream

Returns:
0 for success, -1 for failure
Throws:
LibvirtException
See Also:
Libvirt Docs

send

public int send(java.lang.String data)
         throws LibvirtException
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)
            throws LibvirtException
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)
                   throws LibvirtException
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