|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xensource.xenapi.XenAPIObject
com.xensource.xenapi.Event
public class Event
Asynchronous event registration and handling
Nested Class Summary | |
---|---|
static class |
Event.Record
Represents all the fields in a Event |
Field Summary | |
---|---|
protected String |
ref
The XenAPI reference (OpaqueRef) to this object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
If obj is a Event, compares XenAPI references for equality. |
static Set<Event.Record> |
from(Connection c,
Set<String> classes,
String token,
Double timeout)
Blocking call which returns a (possibly empty) batch of events |
static Long |
getCurrentId(Connection c)
Return the ID of the next event to be generated by the system |
int |
hashCode()
|
static String |
inject(Connection c,
String clazz,
String ref)
Injects an artificial event on the given object and return the corresponding ID |
static Set<Event.Record> |
next(Connection c)
Blocking call which returns a (possibly empty) batch of events |
static void |
register(Connection c,
Set<String> classes)
Registers this session with the event system. |
static Task |
registerAsync(Connection c,
Set<String> classes)
Registers this session with the event system. |
String |
toWireString()
|
static void |
unregister(Connection c,
Set<String> classes)
Unregisters this session with the event system |
static Task |
unregisterAsync(Connection c,
Set<String> classes)
Unregisters this session with the event system |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final String ref
Method Detail |
---|
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public static Task registerAsync(Connection c, Set<String> classes) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
classes
- register for events for the indicated classes
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static void register(Connection c, Set<String> classes) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
classes
- register for events for the indicated classes
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task unregisterAsync(Connection c, Set<String> classes) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
classes
- remove this session's registration for the indicated classes
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static void unregister(Connection c, Set<String> classes) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
classes
- remove this session's registration for the indicated classes
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<Event.Record> next(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SessionNotRegistered, Types.EventsLost
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SessionNotRegistered
Types.EventsLost
public static Set<Event.Record> from(Connection c, Set<String> classes, String token, Double timeout) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SessionNotRegistered, Types.EventsLost
classes
- register for events for the indicated classestoken
- A token representing the point from which to generate database events. The empty string represents the beginning.timeout
- Return after this many seconds if no events match
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SessionNotRegistered
Types.EventsLost
public static Long getCurrentId(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static String inject(Connection c, String clazz, String ref) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
clazz
- class of the objectref
- A reference to the object that will be changed.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |