summaryrefslogtreecommitdiffstats
path: root/tinySIP/src/dialogs/tsip_dialog_subscribe.client.c
blob: 89877def9ec446904e52f94a6a6ea356b725493a (plain)
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
/*
* Copyright (C) 2010-2011 Mamadou Diop.
*
* Contact: Mamadou Diop <diopmamadou(at)doubango[dot]org>
*
* This file is part of Open Source Doubango Framework.
*
* DOUBANGO is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* DOUBANGO is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with DOUBANGO.
*
*/

/**@file tsip_dialog_subscribe.client.c
 * @brief SIP dialog SUBSCRIBE (Client side) as per RFC 3265.
 *
 * @author Mamadou Diop <diopmamadou(at)doubango[dot]org>
 *

 */
#include "tinysip/dialogs/tsip_dialog_subscribe.h"

#include "tinysip/headers/tsip_header_Dummy.h"
#include "tinysip/headers/tsip_header_Event.h"
#include "tinysip/headers/tsip_header_Min_Expires.h"
#include "tinysip/headers/tsip_header_Subscription_State.h"

#include "tinysip/transactions/tsip_transac_layer.h"

#include "tinysip/api/tsip_api_subscribe.h"

#include "tsk_debug.h"
#include "tsk_time.h"



#define DEBUG_STATE_MACHINE											0
#define TSIP_DIALOG_SUBSCRIBE_TIMER_SCHEDULE(TX)						TSIP_DIALOG_TIMER_SCHEDULE(subscribe, TX)
#define TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, type, code, phrase, message)	\
	tsip_subscribe_event_signal(type, TSIP_DIALOG(self)->ss, code, phrase, message)

/* ======================== internal functions ======================== */
static int process_i_notify(tsip_dialog_subscribe_t *self, const tsip_request_t* notify);
static int send_SUBSCRIBE(tsip_dialog_subscribe_t *self);
static int send_200NOTIFY(tsip_dialog_subscribe_t *self, const tsip_request_t* request);
static int tsip_dialog_subscribe_OnTerminated(tsip_dialog_subscribe_t *self);

/* ======================== transitions ======================== */
static int tsip_dialog_subscribe_Started_2_Trying_X_subscribe(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Trying_X_1xx(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Terminated_X_2xx(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Connected_X_2xx(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Trying_X_401_407_421_494(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Trying_X_423(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Terminated_X_300_to_699(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Terminated_X_cancel(va_list *app);
static int tsip_dialog_subscribe_Trying_2_Trying_X_NOTIFY(va_list *app);
static int tsip_dialog_subscribe_Connected_2_Trying_X_unsubscribe(va_list *app);
static int tsip_dialog_subscribe_Connected_2_Trying_X_subscribe(va_list *app);
static int tsip_dialog_subscribe_Connected_2_Connected_X_NOTIFY(va_list *app);
static int tsip_dialog_subscribe_Connected_2_Terminated_X_NOTIFY(va_list *app);
static int tsip_dialog_subscribe_Any_2_Trying_X_hangup(va_list *app);
static int tsip_dialog_subscribe_Any_2_Trying_X_shutdown(va_list *app);
static int tsip_dialog_subscribe_Any_2_Terminated_X_transportError(va_list *app);
static int tsip_dialog_subscribe_Any_2_Terminated_X_Error(va_list *app);


/* ======================== conds ======================== */
static tsk_bool_t _fsm_cond_unsubscribing(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    return dialog->unsubscribing;
}
static tsk_bool_t _fsm_cond_subscribing(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    return !_fsm_cond_unsubscribing(dialog, message);
}

static tsk_bool_t _fsm_cond_notify_terminated(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    const tsip_header_Subscription_State_t *hdr_state;
    if((hdr_state = (const tsip_header_Subscription_State_t*)tsip_message_get_header(message, tsip_htype_Subscription_State))) {
        return tsk_striequals(hdr_state->state, "terminated") &&
               (hdr_state->expires < 0 || tsk_striequals(hdr_state->reason, "rejected") || tsk_striequals(hdr_state->reason, "noresource"));
    }
    return tsk_false;
}
static tsk_bool_t _fsm_cond_notify_not_terminated(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    return !_fsm_cond_notify_terminated(dialog, message);
}

static tsk_bool_t _fsm_cond_silent_hangup(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    return TSIP_DIALOG(dialog)->ss->silent_hangup;
}
static tsk_bool_t _fsm_cond_not_silent_hangup(tsip_dialog_subscribe_t* dialog, tsip_message_t* message)
{
    return !TSIP_DIALOG(dialog)->ss->silent_hangup;
}
#define _fsm_cond_silent_shutdown _fsm_cond_silent_hangup
#define _fsm_cond_not_silent_shutdown _fsm_cond_not_silent_hangup

/* ======================== actions ======================== */
typedef enum _fsm_action_e {
    _fsm_action_subscribe = tsip_atype_subscribe,
    _fsm_action_hangup = tsip_atype_hangup,
    _fsm_action_cancel = tsip_atype_cancel,
    _fsm_action_shutdown = tsip_atype_shutdown,
    _fsm_action_transporterror = tsip_atype_transport_error,

    _fsm_action_1xx = 0xFF,
    _fsm_action_2xx,
    _fsm_action_401_407_421_494,
    _fsm_action_423,
    _fsm_action_300_to_699,
    _fsm_action_shutdown_timedout, /* Any -> Terminated */
    _fsm_action_notify,
    _fsm_action_error,
}
_fsm_action_t;

/* ======================== states ======================== */
typedef enum _fsm_state_e {
    _fsm_state_Started,
    _fsm_state_Trying,
    _fsm_state_Connected,
    _fsm_state_Terminated
}
_fsm_state_t;

/**
 * Callback function called to alert the dialog for new events from the transaction/transport layers.
 *
 * @param [in,out]	self	A reference to the dialog.
 * @param	type		The event type.
 * @param [in,out]	msg	The incoming SIP/IMS message.
 *
 * @return	Zero if succeed and non-zero error code otherwise.
**/
int tsip_dialog_subscribe_event_callback(const tsip_dialog_subscribe_t *self, tsip_dialog_event_type_t type, const tsip_message_t *msg)
{
    int ret = -1;

    switch(type) {
    case tsip_dialog_i_msg: {
        if(msg && TSIP_MESSAGE_IS_RESPONSE(msg)) {
            //
            //	RESPONSE
            //
            const tsip_action_t* action = tsip_dialog_keep_action(TSIP_DIALOG(self), msg) ? TSIP_DIALOG(self)->curr_action : tsk_null;
            if(TSIP_RESPONSE_IS_1XX(msg)) {
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_1xx, msg, action);
            }
            else if(TSIP_RESPONSE_IS_2XX(msg)) {
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_2xx, msg, action);
            }
            else if(TSIP_RESPONSE_IS(msg,401) || TSIP_RESPONSE_IS(msg,407) || TSIP_RESPONSE_IS(msg,421) || TSIP_RESPONSE_IS(msg,494)) {
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_401_407_421_494, msg, action);
            }
            else if(TSIP_RESPONSE_IS(msg,423)) {
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_423, msg, action);
            }
            else {
                // Alert User
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_error, msg, action);
                /* TSK_DEBUG_WARN("Not supported status code: %d", TSIP_RESPONSE_CODE(msg)); */
            }
        }
        else {
            //
            //	REQUEST
            //
            if(TSIP_REQUEST_IS_NOTIFY(msg)) {
                ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_notify, msg, tsk_null);
            }
        }
        break;
    }

    case tsip_dialog_canceled: {
        ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_cancel, msg, tsk_null);
        break;
    }

    case tsip_dialog_terminated:
    case tsip_dialog_timedout:
    case tsip_dialog_error:
    case tsip_dialog_transport_error: {
        ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_transporterror, msg, tsk_null);
        break;
    }

    default:
        break;
    }

    return ret;
}

/** Timer manager callback.
 *
 * @param [in,out]	self	The owner of the signaled timer.
 * @param	timer_id		The identifier of the signaled timer.
 *
 * @return	Zero if succeed and non-zero error code otherwise.
**/
int tsip_dialog_subscribe_timer_callback(const tsip_dialog_subscribe_t* self, tsk_timer_id_t timer_id)
{
    int ret = -1;

    if(self) {
        if(timer_id == self->timerrefresh.id) {
            tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_subscribe, tsk_null, tsk_null);
            ret = 0;
        }
        else if(timer_id == self->timershutdown.id) {
            ret = tsip_dialog_fsm_act(TSIP_DIALOG(self), _fsm_action_shutdown_timedout, tsk_null, tsk_null);
        }
    }
    return ret;
}

tsip_dialog_subscribe_t* tsip_dialog_subscribe_create(const tsip_ssession_handle_t* ss)
{
    return tsk_object_new(tsip_dialog_subscribe_def_t, ss);
}

/**	Initializes the dialog.
 *
 * @param [in,out]	self	The dialog to initialize.
**/
int tsip_dialog_subscribe_init(tsip_dialog_subscribe_t *self)
{
    /* Initialize the State Machine. */
    tsk_fsm_set(TSIP_DIALOG_GET_FSM(self),

                /*=======================
                * === Started ===
                */
                // Started -> (Send) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Started, _fsm_action_subscribe, _fsm_state_Trying, tsip_dialog_subscribe_Started_2_Trying_X_subscribe, "tsip_dialog_subscribe_Started_2_Trying_X_subscribe"),
                // Started -> (Any) -> Started
                TSK_FSM_ADD_ALWAYS_NOTHING(_fsm_state_Started, "tsip_dialog_subscribe_Started_2_Started_X_any"),


                /*=======================
                * === Trying ===
                */
                // Trying -> (1xx) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_1xx, _fsm_state_Trying, tsip_dialog_subscribe_Trying_2_Trying_X_1xx, "tsip_dialog_subscribe_Trying_2_Trying_X_1xx"),
                // Trying -> (2xx) -> Terminated
                TSK_FSM_ADD(_fsm_state_Trying, _fsm_action_2xx, _fsm_cond_unsubscribing, _fsm_state_Terminated, tsip_dialog_subscribe_Trying_2_Terminated_X_2xx, "tsip_dialog_subscribe_Trying_2_Terminated_X_2xx"),
                // Trying -> (2xx) -> Connected
                TSK_FSM_ADD(_fsm_state_Trying, _fsm_action_2xx, _fsm_cond_subscribing, _fsm_state_Connected, tsip_dialog_subscribe_Trying_2_Connected_X_2xx, "tsip_dialog_subscribe_Trying_2_Connected_X_2xx"),
                // Trying -> (401/407/421/494) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_401_407_421_494, _fsm_state_Trying, tsip_dialog_subscribe_Trying_2_Trying_X_401_407_421_494, "tsip_dialog_subscribe_Trying_2_Trying_X_401_407_421_494"),
                // Trying -> (423) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_423, _fsm_state_Trying, tsip_dialog_subscribe_Trying_2_Trying_X_423, "tsip_dialog_subscribe_Trying_2_Trying_X_423"),
                // Trying -> (300_to_699) -> Terminated
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_300_to_699, _fsm_state_Terminated, tsip_dialog_subscribe_Trying_2_Terminated_X_300_to_699, "tsip_dialog_subscribe_Trying_2_Terminated_X_300_to_699"),
                // Trying -> (cancel) -> Terminated
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_cancel, _fsm_state_Terminated, tsip_dialog_subscribe_Trying_2_Terminated_X_cancel, "tsip_dialog_subscribe_Trying_2_Terminated_X_cancel"),
                // Trying -> (Notify) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_notify, _fsm_state_Trying, tsip_dialog_subscribe_Trying_2_Trying_X_NOTIFY, "tsip_dialog_subscribe_Trying_2_Trying_X_NOTIFY"),
                // Trying -> (hangup) -> Terminated
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_hangup, _fsm_state_Terminated, tsk_null, "tsip_dialog_subscribe_Trying_2_Terminated_X_hangup"),
                // Trying -> (shutdown) -> Terminated
                TSK_FSM_ADD_ALWAYS(_fsm_state_Trying, _fsm_action_shutdown, _fsm_state_Terminated, tsk_null, "tsip_dialog_subscribe_Trying_2_Terminated_X_shutdown"),
                // Trying -> (Any) -> Trying
                //TSK_FSM_ADD_ALWAYS_NOTHING(_fsm_state_Trying, "tsip_dialog_subscribe_Trying_2_Trying_X_any"),


                /*=======================
                * === Connected ===
                */
                // Connected -> (SUBSCRIBE) -> Trying
                TSK_FSM_ADD_ALWAYS(_fsm_state_Connected, _fsm_action_subscribe, _fsm_state_Trying, tsip_dialog_subscribe_Connected_2_Trying_X_subscribe, "tsip_dialog_subscribe_Connected_2_Trying_X_subscribe"),
                // Connected -> (NOTIFY) -> Connected
                TSK_FSM_ADD(_fsm_state_Connected, _fsm_action_notify, _fsm_cond_notify_not_terminated, _fsm_state_Connected, tsip_dialog_subscribe_Connected_2_Connected_X_NOTIFY, "tsip_dialog_subscribe_Connected_2_Connected_X_NOTIFY"),
                // Connected -> (NOTIFY) -> Terminated
                TSK_FSM_ADD(_fsm_state_Connected, _fsm_action_notify, _fsm_cond_notify_terminated, _fsm_state_Terminated, tsip_dialog_subscribe_Connected_2_Terminated_X_NOTIFY, "tsip_dialog_subscribe_Connected_2_Terminated_X_NOTIFY"),

                /*=======================
                * === Any ===
                */
                // Any -> (hangup) -> Trying
                TSK_FSM_ADD(tsk_fsm_state_any, _fsm_action_hangup, _fsm_cond_not_silent_hangup, _fsm_state_Trying, tsip_dialog_subscribe_Any_2_Trying_X_hangup, "tsip_dialog_subscribe_Any_2_Trying_X_hangup"),
                // Any -> (silenthangup) -> Terminated
                TSK_FSM_ADD(tsk_fsm_state_any, _fsm_action_hangup, _fsm_cond_silent_hangup, _fsm_state_Terminated, tsk_null, "tsip_dialog_subscribe_Any_2_Trying_X_silenthangup"),
                // Any -> (shutdown) -> Trying
                TSK_FSM_ADD(tsk_fsm_state_any, _fsm_action_shutdown, _fsm_cond_not_silent_shutdown, _fsm_state_Trying, tsip_dialog_subscribe_Any_2_Trying_X_shutdown, "tsip_dialog_subscribe_Any_2_Trying_X_shutdown"),
                // Any -> (silentshutdown) -> Terminated
                TSK_FSM_ADD(tsk_fsm_state_any, _fsm_action_shutdown, _fsm_cond_silent_shutdown, _fsm_state_Terminated, tsk_null, "tsip_dialog_subscribe_Any_2_Trying_X_silentshutdown"),
                // Any -> (shutdown timedout) -> Terminated
                TSK_FSM_ADD_ALWAYS(tsk_fsm_state_any, _fsm_action_shutdown_timedout, _fsm_state_Terminated, tsk_null, "tsip_dialog_subscribe_shutdown_timedout"),
                // Any -> (transport error) -> Terminated
                TSK_FSM_ADD_ALWAYS(tsk_fsm_state_any, _fsm_action_transporterror, _fsm_state_Terminated, tsip_dialog_subscribe_Any_2_Terminated_X_transportError, "tsip_dialog_subscribe_Any_2_Terminated_X_transportError"),
                // Any -> (error) -> Terminated
                TSK_FSM_ADD_ALWAYS(tsk_fsm_state_any, _fsm_action_error, _fsm_state_Terminated, tsip_dialog_subscribe_Any_2_Terminated_X_Error, "tsip_dialog_subscribe_Any_2_Terminated_X_Error"),

                TSK_FSM_ADD_NULL());

    /* Sets callback function */
    TSIP_DIALOG(self)->callback = TSIP_DIALOG_EVENT_CALLBACK_F(tsip_dialog_subscribe_event_callback);

    /* Timers */
    self->timerrefresh.id = TSK_INVALID_TIMER_ID;
    self->timerrefresh.timeout = TSIP_DIALOG(self)->expires;
    self->timershutdown.id = TSK_INVALID_TIMER_ID;
    self->timershutdown.timeout = TSIP_DIALOG_SHUTDOWN_TIMEOUT;

    return 0;
}


//--------------------------------------------------------
//				== STATE MACHINE BEGIN ==
//--------------------------------------------------------

/* Started -> (SUBSCRIBE) -> Trying
*/
int tsip_dialog_subscribe_Started_2_Trying_X_subscribe(va_list *app)
{
    tsip_dialog_subscribe_t *self;

    self = va_arg(*app, tsip_dialog_subscribe_t *);

    TSIP_DIALOG(self)->running = tsk_true;

    /* alert the user */
    TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_connecting, "Dialog connecting");

    return send_SUBSCRIBE(self);
}

/* Trying -> (1xx) -> Trying
*/
int tsip_dialog_subscribe_Trying_2_Trying_X_1xx(va_list *app)
{
    /*tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);*/
    /*const tsip_response_t *response = va_arg(*app, const tsip_response_t *);*/

    return 0;
}

/* Trying -> (2xx) -> Terminated
*/
int tsip_dialog_subscribe_Trying_2_Terminated_X_2xx(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    /* Alert the user. */
    TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, self->unsubscribing ? tsip_ao_unsubscribe : tsip_ao_subscribe,
                                 TSIP_RESPONSE_CODE(response), TSIP_RESPONSE_PHRASE(response), response);

    return 0;
}

/* Trying -> (2xx) -> Connected
*/
int tsip_dialog_subscribe_Trying_2_Connected_X_2xx(va_list *app)
{
    int ret;
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    tsk_bool_t first_time_to_connect = (TSIP_DIALOG(self)->state == tsip_initial);

    /* Update the dialog state. */
    if((ret = tsip_dialog_update(TSIP_DIALOG(self), response))) {
        return ret;
    }

    /* Alert the user(session) */
    TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, self->unsubscribing ? tsip_ao_unsubscribe : tsip_ao_subscribe,
                                 TSIP_RESPONSE_CODE(response), TSIP_RESPONSE_PHRASE(response), response);
    /* Alert the user(dialog) */
    if(first_time_to_connect) {
        TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_connected, "Dialog connected");
    }

    /* Reset current action */
    tsip_dialog_set_curr_action(TSIP_DIALOG(self), tsk_null);

    /* Request timeout for dialog refresh (re-subscribtion). */
    self->timerrefresh.timeout = tsip_dialog_get_newdelay(TSIP_DIALOG(self), response);
    TSIP_DIALOG_SUBSCRIBE_TIMER_SCHEDULE(refresh);

    return 0;
}

/* Trying -> (401/407/421/494) -> Trying
*/
int tsip_dialog_subscribe_Trying_2_Trying_X_401_407_421_494(va_list *app)
{
    int ret;
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    if((ret = tsip_dialog_update(TSIP_DIALOG(self), response))) {
        /* Alert the user. */
        TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, self->unsubscribing ? tsip_ao_unsubscribe : tsip_ao_subscribe,
                                     TSIP_RESPONSE_CODE(response), TSIP_RESPONSE_PHRASE(response), response);

        return ret;
    }

    return send_SUBSCRIBE(self);
}

/* Trying -> (423) -> Trying
*/
int tsip_dialog_subscribe_Trying_2_Trying_X_423(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    tsip_header_Min_Expires_t *hdr;

    /*
    RFC 3261 - 10.2.8 Error Responses

    If a UA receives a 423 (Interval Too Brief) response, it MAY retry
    the registration after making the expiration interval of all contact
    addresses in the SUBSCRIBE request equal to or greater than the
    expiration interval within the Min-Expires header field of the 423
    (Interval Too Brief) response.
    */
    hdr = (tsip_header_Min_Expires_t*)tsip_message_get_header(response, tsip_htype_Min_Expires);
    if(hdr) {
        TSIP_DIALOG(self)->expires = TSK_TIME_S_2_MS(hdr->value);
        send_SUBSCRIBE(self);
    }
    else {
        TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_message_error, "Received invalid SIP response.");

        return -1;
    }

    return 0;
}

/* Trying -> (300-699) -> Terminated
*/
int tsip_dialog_subscribe_Trying_2_Terminated_X_300_to_699(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    /* save last error */
    tsip_dialog_set_lasterror_2(TSIP_DIALOG(self), TSIP_RESPONSE_PHRASE(response), TSIP_RESPONSE_CODE(response), response);

    /* alert the user */
    TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, self->unsubscribing ? tsip_ao_unsubscribe : tsip_ao_subscribe,
                                 TSIP_RESPONSE_CODE(response), TSIP_RESPONSE_PHRASE(response), response);

    return 0;
}

/* Trying -> (cancel) -> Terminated
*/
int tsip_dialog_subscribe_Trying_2_Terminated_X_cancel(va_list *app)
{
    int ret;
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    /* const tsip_response_t *response = va_arg(*app, const tsip_response_t *); */

    /* Cancel all transactions associated to this dialog (will also be done when the dialog is destroyed (worth nothing)) */
    ret = tsip_transac_layer_cancel_by_dialog(TSIP_DIALOG_GET_STACK(self)->layer_transac, TSIP_DIALOG(self));

    /*	RFC 3261 - 9.1 Client Behavior
    	A CANCEL request SHOULD NOT be sent to cancel a request other than INVITE.
    */

    /* alert the user */
    TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_request_cancelled, "Subscription cancelled");

    return ret;
}

/* Trying -> (NOTIFY) -> Trying
*/
int tsip_dialog_subscribe_Trying_2_Trying_X_NOTIFY(va_list *app)
{
    int ret;

    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_request_t *request = va_arg(*app, const tsip_request_t *);

    ret = send_200NOTIFY(self, request);
    ret = process_i_notify(self, request);

    return ret;
}

/* Connected -> (SUBSCRIBE) -> Trying
*/
int tsip_dialog_subscribe_Connected_2_Trying_X_subscribe(va_list *app)
{
    tsip_dialog_subscribe_t *self;

    self = va_arg(*app, tsip_dialog_subscribe_t *);

    return send_SUBSCRIBE(self);
}

/* Connected -> (NOTIFY) -> Connected
*/
int tsip_dialog_subscribe_Connected_2_Connected_X_NOTIFY(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_request_t *request = va_arg(*app, const tsip_request_t *);
    int ret;

    ret = send_200NOTIFY(self, request);
    ret = process_i_notify(self, request);

    return ret;
}

/* Connected -> (NOTIFY) -> Terminated
*/
int tsip_dialog_subscribe_Connected_2_Terminated_X_NOTIFY(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_request_t *request = va_arg(*app, const tsip_request_t *);

    /* Alert the user */
    TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, tsip_i_notify,
                                 tsip_event_code_dialog_request_incoming, "Incoming NOTIFY.", request);

    return send_200NOTIFY(self, request);
}

/* Any -> (hangup) -> Trying
*/
int tsip_dialog_subscribe_Any_2_Trying_X_hangup(va_list *app)
{
    tsip_dialog_subscribe_t *self;

    self = va_arg(*app, tsip_dialog_subscribe_t *);

    /* Alert the user */
    TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_terminating, "Terminating dialog");

    self->unsubscribing = tsk_true;
    return send_SUBSCRIBE(self);
}

/* Any -> (shutdown) -> Trying
*/
int tsip_dialog_subscribe_Any_2_Trying_X_shutdown(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);

    /* schedule shutdow timeout */
    TSIP_DIALOG_SUBSCRIBE_TIMER_SCHEDULE(shutdown);

    /* alert user */
    TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_terminating, "Terminating dialog");

    self->unsubscribing = tsk_true;
    return send_SUBSCRIBE(self);
}

/* Any -> (transport error) -> Terminated
*/
int tsip_dialog_subscribe_Any_2_Terminated_X_transportError(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    /* const tsip_response_t *response = va_arg(*app, const tsip_response_t *); */

    /* Alert the user. */
    TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_transport_error, "Transport error.");

    return 0;
}

/* Any -> (error) -> Terminated
*/
int tsip_dialog_subscribe_Any_2_Terminated_X_Error(va_list *app)
{
    tsip_dialog_subscribe_t *self = va_arg(*app, tsip_dialog_subscribe_t *);
    const tsip_response_t *response = va_arg(*app, const tsip_response_t *);

    // save last error
    tsip_dialog_set_lasterror_2(TSIP_DIALOG(self), TSIP_RESPONSE_PHRASE(response), TSIP_RESPONSE_CODE(response), response);

    /* Alert user */
    if(response) {
        TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, self->unsubscribing ? tsip_ao_unsubscribe : tsip_ao_subscribe,
                                     TSIP_RESPONSE_CODE(response), TSIP_RESPONSE_PHRASE(response), response);
    }
    else {
        TSIP_DIALOG_SIGNAL(self, tsip_event_code_dialog_global_error, "Global error.");
    }

    return 0;
}


//++++++++++++++++++++++++++++++++++++++++++++++++++++++++
//				== STATE MACHINE END ==
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++

/**
 * Sends a SUBSCRIBE request.
 *
 * @param [in,out]	self	The caller.
 *
 * @return	Zero if succeed and non-zero error code otherwise.
**/
int send_SUBSCRIBE(tsip_dialog_subscribe_t *self)
{
    tsip_request_t *request;
    int ret = -1;

    if(self->unsubscribing) {
        TSIP_DIALOG(self)->expires = 0;
    }

    if((request = tsip_dialog_request_new(TSIP_DIALOG(self), "SUBSCRIBE"))) {
        /* apply action params to the request */
        if(TSIP_DIALOG(self)->curr_action) {
            tsip_dialog_apply_action(request, TSIP_DIALOG(self)->curr_action);
        }
        /* send the request */
        ret = tsip_dialog_request_send(TSIP_DIALOG(self), request);
        TSK_OBJECT_SAFE_FREE(request);
    }

    return ret;
}

int send_200NOTIFY(tsip_dialog_subscribe_t *self, const tsip_request_t* request)
{
    tsip_response_t *response;
    int ret = -1;

    if((response = tsip_dialog_response_new(TSIP_DIALOG(self), 200, "OK", request))) {
        ret = tsip_dialog_response_send(TSIP_DIALOG(self), response);
        TSK_OBJECT_SAFE_FREE(response);
    }
    return ret;
}

// process incoming notify: refresh delay and alert the user
int process_i_notify(tsip_dialog_subscribe_t *self, const tsip_request_t* notify)
{
    if(!self || !notify) {
        TSK_DEBUG_ERROR("Invalid parameter");
        return -1;
    }

    /* Request timeout for dialog refresh (re-registration). */
    self->timerrefresh.timeout = tsip_dialog_get_newdelay(TSIP_DIALOG(self), notify);
    TSIP_DIALOG_SUBSCRIBE_TIMER_SCHEDULE(refresh);

    /* Alert the user */
    TSIP_DIALOG_SUBSCRIBE_SIGNAL(self, tsip_i_notify,
                                 tsip_event_code_dialog_request_incoming, "Incoming NOTIFY.", notify);

    return 0;
}

/**
 * Callback function called by the state machine manager to signal that the final state has been reached.
 *
 * @param [in,out]	self	The state machine owner.
**/
int tsip_dialog_subscribe_OnTerminated(tsip_dialog_subscribe_t *self)
{
    TSK_DEBUG_INFO("=== SUBSCRIBE Dialog terminated ===");

    /* Alert the user */
    TSIP_DIALOG_SIGNAL_2(self, tsip_event_code_dialog_terminated,
                         TSIP_DIALOG(self)->last_error.phrase ? TSIP_DIALOG(self)->last_error.phrase : "Dialog terminated",
                         TSIP_DIALOG(self)->last_error.message);

    /* Remove from the dialog layer. */
    return tsip_dialog_remove(TSIP_DIALOG(self));
}














//========================================================
//	SIP dialog SUBSCRIBE object definition
//
static tsk_object_t* tsip_dialog_subscribe_ctor(tsk_object_t * self, va_list * app)
{
    tsip_dialog_subscribe_t *dialog = self;
    if(dialog) {
        tsip_ssession_handle_t *ss = va_arg(*app, tsip_ssession_handle_t *);

        /* Initialize base class */
        tsip_dialog_init(TSIP_DIALOG(self), tsip_dialog_SUBSCRIBE, tsk_null, ss, _fsm_state_Started, _fsm_state_Terminated);

        /* FSM */
        TSIP_DIALOG_GET_FSM(self)->debug = DEBUG_STATE_MACHINE;
        tsk_fsm_set_callback_terminated(TSIP_DIALOG_GET_FSM(self), TSK_FSM_ONTERMINATED_F(tsip_dialog_subscribe_OnTerminated), (const void*)dialog);

        /* Initialize the class itself */
        tsip_dialog_subscribe_init(self);
    }
    return self;
}

static tsk_object_t* tsip_dialog_subscribe_dtor(tsk_object_t * _self)
{
    tsip_dialog_subscribe_t *self = _self;
    if(self) {
        /* Cancel all timers */
        TSIP_DIALOG_TIMER_CANCEL(refresh);
        TSIP_DIALOG_TIMER_CANCEL(shutdown);

        /* DeInitialize base class (will cancel all transactions) */
        tsip_dialog_deinit(TSIP_DIALOG(self));

        TSK_DEBUG_INFO("*** SUBSCRIBE Dialog destroyed ***");
    }
    return self;
}

static int tsip_dialog_subscribe_cmp(const tsk_object_t *obj1, const tsk_object_t *obj2)
{
    return tsip_dialog_cmp(obj1, obj2);
}

static const tsk_object_def_t tsip_dialog_subscribe_def_s = {
    sizeof(tsip_dialog_subscribe_t),
    tsip_dialog_subscribe_ctor,
    tsip_dialog_subscribe_dtor,
    tsip_dialog_subscribe_cmp,
};
const tsk_object_def_t *tsip_dialog_subscribe_def_t = &tsip_dialog_subscribe_def_s;
OpenPOWER on IntegriCloud