Scope

Generated:opprotoc –rst-doc Version:0.50 Status:Draft Introduced:core 2.4

service Scope
{
  option version          = "1.0";
  option core_release     = "2.4";

  command Connect(ClientInfo)       returns ConnectionInfo = 3;
  command Disconnect(ClientID)      returns Default        = 4;
  command Enable(ServiceSelection)  returns ServiceResult  = 5;
  command Disable(ServiceSelection) returns ServiceResult  = 6;
  command Info(ServiceSelection)    returns ServiceInfo    = 7;
  command Quit(Default)             returns Default        = 8;
  command HostInfo(Default)         returns HostInfo       = 10;
  event   OnServices                returns ServiceList    = 0;
  event   OnQuit                    returns Default        = 1;
  event   OnConnectionLost          returns Default        = 2;
  event   OnError                   returns ErrorInfo      = 9;
}

Commands

Connect

command Connect(ClientInfo) returns ConnectionInfo = 3;

argument:

message ClientInfo
{
  required string format = 1;
  required string uuid   = 2;
}

returns:

message ConnectionInfo
{
  required uint32 clientID = 1;
}

Disconnect

command Disconnect(ClientID) returns Default = 4;

argument:

message ClientID
{
  required string uuid = 1;
}

returns:

message Default
{
}

Enable

command Enable(ServiceSelection) returns ServiceResult = 5;

argument:

message ServiceSelection
{
  required string name = 1;
}

returns:

message ServiceResult
{
  required string name = 1;
}

Disable

command Disable(ServiceSelection) returns ServiceResult = 6;

argument:

message ServiceSelection
{
  required string name = 1;
}

returns:

message ServiceResult
{
  required string name = 1;
}

Info

command Info(ServiceSelection) returns ServiceInfo = 7;

argument:

message ServiceSelection
{
  required string name = 1;
}

returns:

message ServiceInfo
{
  message CommandInfo
  {
    required string name   = 1;
    required uint32 number = 2;
  }
  message EventInfo
  {
    required string name   = 1;
    required uint32 number = 2;
  }
  repeated CommandInfo commandList = 1;
  repeated EventInfo   eventList   = 2;
}

Quit

command Quit(Default) returns Default = 8;

argument:

message Default
{
}

returns:

message Default
{
}

HostInfo

command HostInfo(Default) returns HostInfo = 10;

argument:

message Default
{
}

returns:

message HostInfo
{
  message Service
  {
    required string name          = 1;
    required string version       = 2;
    required uint32 activeClients = 3;
    required uint32 maxClients    = 4;
  }
  required uint32  stpVersion      = 1;
  required string  coreVersion     = 2;
  required string  platform        = 3;
  required string  operatingSystem = 4;
  required string  userAgent       = 5;
  repeated Service serviceList     = 6;
}

Events

OnServices

event OnServices returns ServiceList = 0;

message:

message ServiceList
{
  repeated string serviceList = 1;
}

OnQuit

event OnQuit returns Default = 1;

message:

message Default
{
}

OnConnectionLost

event OnConnectionLost returns Default = 2;

message:

message Default
{
}

OnError

event OnError returns ErrorInfo = 9;

message:

message ErrorInfo
{
  required string description = 1;
}