1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
// MIT License
//
// Copyright (c) 2019-2021 Alessandro Cresto Miseroglio <alex179ohm@gmail.com>
// Copyright (c) 2019-2021 Tangram Technologies S.R.L. <https://tngrm.io>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use actix::prelude::*;

use crate::codec::Cmd;
use crate::error::Error;
use crate::auth::AuthResp;
use crate::config::NsqdConfig;

pub trait NsqMsg: Message<Result = ()> + Send + 'static {}

impl<M> NsqMsg for M
where
    M: Message<Result = ()> + Send + 'static
{}

#[derive(Message)]
pub struct AddHandler<M: NsqMsg>(pub Recipient<M>);

/// Message sent by nsqd
///
/// # Examples
/// ```no-run
/// struct Consumer(Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn handle(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<Msg>(ctx, self.0.clone());
///     }
/// }
///
/// fn Handler<Msg> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: Msg, _: &mut Self::Context) {
///         println!("timestamp: {}", msg.timestamp);
///         println!("attemps: {}", msg.attemps);
///         println!("id: {}", msg.id);
///         println!("data: {}", msg.body);
///         println!("msg debug: {:?}", msg);
///     }
/// }
///
/// ```
#[derive(Clone, Debug, Message)]
pub struct Msg
{
    /// Timestamp of the message
    pub timestamp: i64,
    /// Number of attemps reader tried to process the message
    pub attemps: u16,
    /// Id of the message
    pub id: String,
    /// Data sent by nsqd
    pub body: Vec<u8>,
}

impl Default for Msg {
    fn default() -> Self {
        Self {
            timestamp: 0,
            attemps: 0,
            id: "".to_owned(),
            body: Vec::new(),
        }
    }
}

/// Sent by [Connection](struct.Connection.html) every time in_fligth is increased or decreased
#[derive(Message)]
pub struct InFlight(pub u32);

#[derive(Message)]
pub struct Auth;

#[derive(Message)]
pub struct Sub;

/// Allows Consumer to change Connection/s RDY
///
/// # Examples
/// ```no-run
/// struct Consumer(Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, _: &mut Self::Context) {
///         self.conn.do_send(Ready(3));
///     }
/// }
/// ```
#[derive(Message)]
pub struct Ready(pub u32);

/// Allows Consumer to set Connection on backoff state
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Subscribe, Connection, Backoff, OnBackoff, OnResume, InFlight, Ready};
/// struct Consumer{
///     conn: Addr<Connection>,
///     backoff: bool,
/// };
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, _: &mut Self::Context) {
///         self.subscribe::<OnBackoff>(ctx, self.0.clone());
///         self.subscribe::<OnResume>(ctx, self.0.clone());
///         self.subscribe::<InFlight>(ctx, self.0.clone());
///         self.conn.do_send(Ready(10));
///         self.conn.do_send(Backoff);
///     }
/// }
///
/// impl Handler<OnBackoff> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnBackoff, _: &mut Self::Context) {
///         println!("Connection in Backoff");
///         self.backoff = true;
///     }
/// }
///
/// impl Handler<OnResume> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnResume, _: &mut Self::Context) {
///         println!("Connection resuming from backoff");
///         self.backoff = false;
///     }
/// }
///
/// impl Handler<OnInflight> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnInFlight, _: &mut Self::Context) {
///         match msg.0 {
///             0 => { println!("backoff state: {}", self.backoff) },
///             1 => { println!("resuming from backoff") },
///             _ => { println!("throttle") },
///         }
///     }
/// }
/// ```
#[derive(Message)]
pub struct Backoff;

#[derive(Message)]
pub struct Resume;

/// Send FIN command to nsqd
///
/// Args:
/// * id - id of the message
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, Msg, Fin};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<Msg>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<Msg> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: Msg, ctx: &mut Self::Conetxt) {
///         self.0.do_send(Fin(msg.id));
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct Fin(pub String);

/// Send REQ command to nsqd
///
/// Args:
/// * id - id of the message
/// * timeout - time spent before message is re-sent by nsqd, 0 will not defer requeuing
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, Requeue, Fin};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<Msg>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<Msg> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: Msg, ctx: &mut Self::Conetxt) {
///         self.0.do_send(Requeue(msg.id, 2));
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct Reqeue(pub String, u32);

/// Send TOUCH command to nsqd (reset timeout for and in-flight message)
///
/// Args:
/// * id - id of the message
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, Touch, Fin};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<Msg>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<Msg> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: Msg, ctx: &mut Self::Conetxt) {
///         self.0.do_send(Touch(msg.id));
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct Touch(pub String);

/// Sent by [Connection](struct.Connection.html) if auth be successful
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, OnAuth};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<OnAuth>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<OnAuth> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnAuth, ctx: &mut Self::Conetxt) {
///         println!("authenticated: {:?}", msg.0);
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct OnAuth(pub AuthResp);

/// Sent by [Connection](struct.Connection.html) after identify succeeds
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, OnIdentify};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<OnIdentify>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<OnIdentify> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnIdentify, ctx: &mut Self::Conetxt) {
///         println!("identified: {:?}", msg.0);
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct OnIdentify(pub NsqdConfig);

/// Sent by [Connection](struct.Connection.html) after CLS is sent to nsqd
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, OnClose};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<OnClose>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<OnClose> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnClose, ctx: &mut Self::Conetxt) {
///         if msg.0 == true {
///             println!("connection closed");
///         } else {
///             println!("connection closing failed");
///         }
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct OnClose(pub bool);

/// Sent by [Connection](struct.Connection.html) after Backoff state is activated
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, OnBackoff};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<OnBackoff>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<OnBackoff> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnBackoff, ctx: &mut Self::Conetxt) {
///         println!("connection backoff activated");
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct OnBackoff;

/// Sent by [Connection](struct.Connection.html) after Backoff state is terminated
///
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Connection, Subscribe, OnResume};
///
/// struct Consumer(pub Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, ctx: &mut Self::Context) {
///         self.subscribe::<OnResume>(ctx, self.0.clone());
///     }
/// }
///
/// impl Handler<OnResume> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnResume, ctx: &mut Self::Conetxt) {
///         println!("resuming connection from backoff state");
///     }
/// }
/// ```
#[derive(Message, Clone)]
pub struct OnResume;

/// Allow Consumer to safefly close nsq [Connection](struct.Connection.html)
///
/// Send nsq CLS connand to nsqd
/// # Examples
/// ```no-run
/// use actix::prelude::*;
/// use nsq_client::{Cls, OnClose, Subscribe, Connection};
///
/// struct Consumer(Addr<Connection>);
///
/// impl Actor for Consumer {
///     type Context = Context<Self>;
///     fn started(&mut self, _: &mut Self::Context) {
///         self.subscribe::<OnClose>(ctx, self.0.clone());
///         self.0.do_send(Cls);
///     }
/// }
///
/// impl Handler<OnClose> for Consumer {
///     type Result = ();
///     fn handle(&mut self, msg: OnClose, _: &mut Self::Context) {
///         if msg.0 {
///             println!("Connection closed");
///         } else {
///             println!("Cannot close Connection");
///         }
///     }
/// }
/// ```
#[derive(Message)]
pub struct Cls;

#[derive(Clone, Debug)]
pub struct Pub(pub String);

impl Message for Pub
{
    type Result = Result<Cmd, Error>;
}