protocol.idl

Go to the documentation of this file.

enum MessageType {
  "method",
  "methodReply",
  "valuechanged"
}


interface BaseMessage {

  attribute DOMString transactionid;
}

enum PropertyType {
  "UInt16",
  "UInt32",
  "Int16",
  "Int32",
  "String",
  "Double",
  "Boolean"
}

interface Property {

  attribute DOMString? property;

   attribute DOMString? value;

   attribute unsigned short zone;

  attribute PropertyType? type;

   attribute unsigned double? timestamp;

   attribute unsigned long? sequence;
}

interface ValueChanged : BaseMessage {

  const MessageType type = "valuechanged";

  attribute DOMString name;

   attribute Property data;
}

interface GetPropertyRequest : BaseMessage {

  const MessageType type = "method";

  const DOMString name = "get";

   attribute Property data;
}

interface GetPropertyReply : BaseMessage {

  const MessageType type = "methodReply";

  const DOMString name = "get";

   attribute Property data;
}

interface GetSupportedRequest : BaseMessage {
  const MessageType type = "method";

  const DOMString name = "getSupported";
}

interface GetSupportedReply : BaseMessage {
  const MessageType type = "methodReply";

  const DOMString name = "getSupported";

  attribute Property[] data;
}

interface SupportedChanged : BaseMessage {
  const MessageType type = "methodReply";

  const DOMString name = "getSupported";

  attribute Property[] data;
}

interface Subscribe : BaseMessage {

  const MessageType type = "method";

  const DOMString name = "subscribe";

   attribute DOMString property;
}

interface Unsubscribe : BaseMessage {

  const MessageType type = "method";

  const DOMString name = "subscribe";

   attribute DOMString property;
}

interface GetRangedRequest : BaseMessage {

  const MessageType type = "method";

  const DOMString name = "getRange";

  attribute DOMString[] data;

   attribute unsigned short? zone;

   attribute unsigned double? timeBegin;

   attribute unsigned double? timeEnd;

   attribute unsigned long? sequenceBegin;

   attribute unsigned long? sequenceEnd;
}

interface GetRangedReply : BaseMessage {
  const MessageType type = "methodReply";

  const DOMString name = "getRanged";

  attribute Property[] data;
}

interface SetPropertyRequest : BaseMessage {

  const MessageType type = "method";

  const DOMString name = "set";

   attribute Property data;
}

enum Error {
  "NoError",
  "Timeout",
  "InvalidOperation",
  "PermissionDenied",
  "ZoneNotSupported"
}

interface SetPropertyReply : BaseMessage {

  const MessageType type = "methodReply";

  const DOMString name = "set";

   attribute Property data;

   attribute boolean success;

   attribute Error error;
}