Add IMAP_UNREAD_MAIL event
[leap_pycommon.git] / src / leap / common / events / events.proto
1 // signal.proto
2 // Copyright (C) 2013 LEAP
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16
17 package leap.common.events;
18 option py_generic_services = true;
19
20
21 // These are the events that can be signaled using the events mechanism.
22
23 enum Event {
24   CLIENT_SESSION_ID = 1;
25   CLIENT_UID = 2;
26   SOLEDAD_CREATING_KEYS = 3;
27   SOLEDAD_DONE_CREATING_KEYS = 4;
28   SOLEDAD_UPLOADING_KEYS = 5;
29   SOLEDAD_DONE_UPLOADING_KEYS = 6;
30   SOLEDAD_DOWNLOADING_KEYS = 7;
31   SOLEDAD_DONE_DOWNLOADING_KEYS = 8;
32   SOLEDAD_NEW_DATA_TO_SYNC = 9;
33   SOLEDAD_DONE_DATA_SYNC = 10;
34   UPDATER_NEW_UPDATES = 11;
35   UPDATER_DONE_UPDATING = 12;
36   RAISE_WINDOW = 13;
37   SMTP_SERVICE_STARTED = 14;
38   SMTP_SERVICE_FAILED_TO_START = 15;
39   SMTP_RECIPIENT_ACCEPTED_ENCRYPTED = 16;
40   SMTP_RECIPIENT_ACCEPTED_UNENCRYPTED = 17;
41   SMTP_RECIPIENT_REJECTED = 18;
42   SMTP_START_ENCRYPT_AND_SIGN = 19;
43   SMTP_END_ENCRYPT_AND_SIGN = 20;
44   SMTP_START_SIGN = 21;
45   SMTP_END_SIGN = 22;
46   SMTP_SEND_MESSAGE_START = 23;
47   SMTP_SEND_MESSAGE_SUCCESS = 24;
48   SMTP_SEND_MESSAGE_ERROR = 25;
49   SMTP_CONNECTION_LOST = 26;
50   IMAP_SERVICE_STARTED = 30;
51   IMAP_SERVICE_FAILED_TO_START = 31;
52   IMAP_CLIENT_LOGIN = 32;
53   IMAP_FETCHED_INCOMING = 33;
54   IMAP_MSG_PROCESSING = 34;
55   IMAP_MSG_DECRYPTED = 35;
56   IMAP_MSG_SAVED_LOCALLY = 36;
57   IMAP_MSG_DELETED_INCOMING = 37;
58   IMAP_UNHANDLED_ERROR = 38;
59   IMAP_UNREAD_MAIL = 39;
60   KEYMANAGER_LOOKING_FOR_KEY = 40;
61   KEYMANAGER_KEY_FOUND = 41;
62   KEYMANAGER_KEY_NOT_FOUND = 42;
63   KEYMANAGER_STARTED_KEY_GENERATION = 43;
64   KEYMANAGER_FINISHED_KEY_GENERATION = 44;
65   KEYMANAGER_DONE_UPLOADING_KEYS = 45;
66 }
67
68
69 // A SignalRequest is the type of the message sent from one component to request
70 // that a signal be sent to every registered component.
71
72 message SignalRequest {
73   required Event event = 1;
74   required string content = 2;
75   required string mac_method = 3;
76   required bytes mac = 4;
77   optional string enc_method = 5;
78   optional bool error_occurred = 6;
79 }
80
81
82 // A RegisterRequest message tells the server that a component wants to
83 // be signaled whenever a specific event occurs.
84
85 message RegisterRequest {
86   required Event event = 1;
87   required int32 port = 2;
88   required string mac_method = 3;
89   required bytes mac = 4;
90 }
91
92
93 // An UnregisterRequest message tells the server that a component does not
94 // want to be signaled when a specific event occurs.
95
96 message UnregisterRequest {
97   required Event event = 1;
98   required int32 port = 2;
99   required string mac_method = 3;
100   required bytes mac = 4;
101 }
102
103
104 // A PingRequest message is used to find out if a server or component is
105 // alive.
106
107 message PingRequest {
108 }
109
110
111 // The EventResponse is the message sent back by server and components after
112 // they receive other kinds of requests.
113
114 message EventResponse {
115
116   enum Status {
117     OK = 1;
118     UNAUTH = 2;
119     ERROR = 3;
120   }
121
122   required Status status = 1;
123   optional string result = 2;
124 }
125
126
127 // The EventsServerService is the service provided by the server.
128
129 service EventsServerService {
130   rpc ping(PingRequest) returns (EventResponse);
131   rpc register(RegisterRequest) returns (EventResponse);
132   rpc unregister(UnregisterRequest) returns (EventResponse);
133   rpc signal(SignalRequest) returns (EventResponse);
134 }
135
136
137 // EventsComponentService is the service provided by components (clients).
138
139 service EventsClientService {
140   rpc ping(PingRequest) returns (EventResponse);
141   rpc signal(SignalRequest) returns (EventResponse);
142 }