wsp_push_client.c File Reference

#include "wsp_push_client.h"
#include "wsp.h"
#include "wtp.h"
#include "wsp_pdu.h"
#include "wsp_headers.h"
#include "wap.h"
#include "wsp_push_client_states.def"
#include "wsp_push_client_machine.def"

Go to the source code of this file.

Macros
#define	PUSH_CLIENT_STATE_NAME(state)   case state : return (unsigned char *)#state;
#define	ROW(state, event, condition, action, new_state)
#define	PUSH_CLIENT_STATE_NAME(state)
#define	ROW(push_state, event_type, condition, action, next_state)
#define	INTEGER(name)   m->name = 0;
#define	HTTPHEADERS(name)   m->name = NULL;
#define	MACHINE(fields)   fields
#define	INTEGER(name)   m->name = 0;
#define	HTTPHEADERS(name)   http_destroy_headers(m->name);
#define	MACHINE(fields)   fields;

Enumerations
enum	{ limbo, running, terminating }

Functions
static WSPPushClientMachine *	push_client_machine_create (long cpid)
static void	push_client_machine_destroy (void *a)
static WSPPushClientMachine *	push_client_machine_find_or_create (WAPEvent *e)
static void	push_client_event_handle (WSPPushClientMachine *cpm, WAPEvent *e)
static unsigned char *	name_push_client_state (int name)
static void	main_thread (void *)
static WAPEvent *	indicate_confirmedpush (WSPPushClientMachine *cpm, Octstr *push_body)
static WAPEvent *	indicate_pushabort (WSPPushClientMachine *cpm, long abort_reason)
static WAPEvent *	response_confirmedpush (WSPPushClientMachine *cpm)
static WAPEvent *	send_abort_to_responder (WSPPushClientMachine *cpm, long reason)
static WAPEvent *	response_responder_invoke (WSPPushClientMachine *cpm)
void	wsp_push_client_init (wap_dispatch_func_t *dispatch_self, wap_dispatch_func_t *dispatch_wtp_resp)
void	wsp_push_client_shutdown (void)
void	wsp_push_client_dispatch_event (WAPEvent *e)
static int	push_client_machine_has_transid (void *a, void *b)
static WSPPushClientMachine *	push_client_machine_find_using_transid (long transid)

Variables
static List *	push_client_machines = NULL
static Counter *	push_client_machine_id_counter = NULL
static enum { ... }	push_client_run_status = limbo
static List *	push_client_queue = NULL
wap_dispatch_func_t *	dispatch_to_self
wap_dispatch_func_t *	dispatch_to_wtp_resp

Macro Definition Documentation

HTTPHEADERS [1/2]

#define HTTPHEADERS

(

name

)

m->name = NULL;

HTTPHEADERS [2/2]

#define HTTPHEADERS

(

name

)

http_destroy_headers(m->name);

INTEGER [1/2]

#define INTEGER

(

name

)

m->name = 0;

INTEGER [2/2]

#define INTEGER

(

name

)

m->name = 0;

MACHINE [1/2]

#define MACHINE

(

fields

)

fields

MACHINE [2/2]

#define MACHINE

(

fields

)

fields;

PUSH_CLIENT_STATE_NAME [1/2]

#define PUSH_CLIENT_STATE_NAME

(

state

)

case state : return (unsigned char *)#state;

PUSH_CLIENT_STATE_NAME [2/2]

#define PUSH_CLIENT_STATE_NAME

(

state

)

ROW [1/2]

#define ROW	(		state,
			event,
			condition,
			action,
			new_state
	)

ROW [2/2]

#define ROW	(		push_state,
			event_type,
			condition,
			action,
			next_state
	)

Value:

if (cpm->state == push_state && \
             e->type == event_type && \
             (condition)) { \
             action \
             cpm->state = next_state; \
             debug("wap.wsp", 0, "WSP_PUSH %ld: new state %s", \
                   cpm->client_push_id, #next_state); \
         } else

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
limbo
running
terminating

Definition at line 94 of file wsp_push_client.c.

{limbo, running, terminating } push_client_run_status = limbo;

Function Documentation

indicate_confirmedpush()

static WAPEvent * indicate_confirmedpush ( WSPPushClientMachine *  cpm, Octstr *  push_body  )

static

Definition at line 416 of file wsp_push_client.c.

References http_header_duplicate(), octstr_duplicate, WAPEvent::u, and wap_event_create.

{
    WAPEvent *e;

    e = wap_event_create(S_ConfirmedPush_Ind);
    e->u.S_ConfirmedPush_Ind.client_push_id = cpm->client_push_id;
    e->u.S_ConfirmedPush_Ind.push_headers = 
        http_header_duplicate(cpm->push_headers);
    e->u.S_ConfirmedPush_Ind.push_body = octstr_duplicate(push_body);

    return e;
}

indicate_pushabort()

static WAPEvent * indicate_pushabort ( WSPPushClientMachine *  cpm, long  abort_reason  )

static

Definition at line 430 of file wsp_push_client.c.

References WAPEvent::u, and wap_event_create.

{
    WAPEvent *e;

    e = wap_event_create(S_PushAbort_Ind);
    e->u.S_PushAbort_Ind.push_id = cpm->client_push_id;
    e->u.S_PushAbort_Ind.reason = abort_reason;

    return e;
}

main_thread()

static void main_thread ( void *  arg )

static

Definition at line 188 of file wsp_push_client.c.

References gwlist_consume(), push_client_event_handle(), push_client_machine_find_or_create(), push_client_queue, push_client_run_status, running, and wap_event_destroy().

Referenced by wsp_push_client_init(), and wsp_push_client_shutdown().

{
    WSPPushClientMachine *cpm;
    WAPEvent *e;

    while (push_client_run_status == running &&
            (e = gwlist_consume(push_client_queue)) != NULL) {
         cpm = push_client_machine_find_or_create(e);
         if (cpm == NULL)
         wap_event_destroy(e);
         else
         push_client_event_handle(cpm, e);
    }
}

name_push_client_state()

static unsigned char * name_push_client_state ( int  name )

static

Definition at line 206 of file wsp_push_client.c.

Referenced by push_client_event_handle().

                                                    {

    switch (n) {
    #define PUSH_CLIENT_STATE_NAME(state) case state : return (unsigned char *)#state;
    #define ROW(state, event, condition, action, new_state)
    #include "wsp_push_client_states.def"
    default:
        return (unsigned char *)"unknown state";
    }
}

push_client_event_handle()

static void push_client_event_handle ( WSPPushClientMachine *  cpm, WAPEvent *  e  )

static

Definition at line 221 of file wsp_push_client.c.

References debug(), error(), gw_assert(), name_push_client_state(), PROTOERR, push_client_machine_destroy(), send_abort_to_responder(), wsp_pdu::type, WAPEvent::type, WAPEvent::u, wap_event_assert(), wap_event_destroy(), wap_event_dump(), wap_event_name(), wsp_pdu_destroy(), wsp_pdu_unpack(), and wtp_resp_dispatch_event().

Referenced by main_thread().

{
    WAPEvent *wtp_event;
    WSP_PDU *pdu = NULL;

    wap_event_assert(e);
    gw_assert(cpm);
    
    if (e->type == TR_Invoke_Ind) {
        pdu = wsp_pdu_unpack(e->u.TR_Invoke_Ind.user_data);
/*
 * Class 1 tests here
 * Case 4, no session matching address quadruplet, handled by the session mach-
 * ine.
 * Tests from table WSP, page 45. Case 5, a PDU state tables cannot handle.
 */
        if (pdu == NULL || pdu->type != ConfirmedPush) {
        wap_event_destroy(e);
            wtp_event = send_abort_to_responder(cpm, PROTOERR);
            wtp_resp_dispatch_event(wtp_event);
            return;
        }
    }

    debug("wap.wsp", 0, "WSP_PUSH: WSPPushClientMachine %ld, state %s,"
          " event %s", 
          cpm->client_push_id,
          name_push_client_state(cpm->state),
          wap_event_name(e->type));
    #define PUSH_CLIENT_STATE_NAME(state)
    #define ROW(push_state, event_type, condition, action, next_state) \
         if (cpm->state == push_state && \
             e->type == event_type && \
             (condition)) { \
             action \
             cpm->state = next_state; \
             debug("wap.wsp", 0, "WSP_PUSH %ld: new state %s", \
                   cpm->client_push_id, #next_state); \
         } else
    #include "wsp_push_client_states.def"
         {
             error(0, "WSP_PUSH: handle_event: unhandled event!");
             debug("wap.wsp", 0, "Unhandled event was:");
             wap_event_dump(e);
             wap_event_destroy(e);
             return;
         }

    wsp_pdu_destroy(pdu);
    wap_event_destroy(e);
    
    if (cpm->state == PUSH_CLIENT_NULL_STATE)
        push_client_machine_destroy(cpm);
}

push_client_machine_create()

static WSPPushClientMachine * push_client_machine_create ( long  cpid )

static

Definition at line 377 of file wsp_push_client.c.

References counter_increase(), debug(), gwlist_append(), push_client_machine_id_counter, and push_client_machines.

Referenced by push_client_machine_find_or_create().

{
    WSPPushClientMachine *m;

    m = gw_malloc(sizeof(WSPPushClientMachine));
    debug("wap.wsp", 0, "WSP_PUSH_CLIENT: Created WSPPushClientMachine %p",
          (void *) m);

    #define INTEGER(name) m->name = 0;
    #define HTTPHEADERS(name) m->name = NULL;
    #define MACHINE(fields) fields
    #include "wsp_push_client_machine.def"

    m->state = PUSH_CLIENT_NULL_STATE;
    m->transaction_id = transid;
    m->client_push_id = counter_increase(push_client_machine_id_counter);

    gwlist_append(push_client_machines, m);

    return m;
}

push_client_machine_destroy()

static void push_client_machine_destroy ( void *  a )

static

Definition at line 399 of file wsp_push_client.c.

References debug(), gwlist_delete_equal(), and push_client_machines.

Referenced by push_client_event_handle(), and wsp_push_client_shutdown().

{
    WSPPushClientMachine *m;

    m = a;
    debug("wap.wsp", 0, "Destroying WSPPushClientMachine %p", (void *) m);
    gwlist_delete_equal(push_client_machines, m); 

    #define INTEGER(name) m->name = 0;
    #define HTTPHEADERS(name) http_destroy_headers(m->name);  
    #define MACHINE(fields) fields;
    #include "wsp_push_client_machine.def"

    gw_free(m);
}

push_client_machine_find_or_create()

static WSPPushClientMachine * push_client_machine_find_or_create ( WAPEvent *  e )

static

Definition at line 305 of file wsp_push_client.c.

References debug(), error(), gw_assert(), push_client_machine_create(), push_client_machine_find_using_transid(), WAPEvent::type, WAPEvent::u, wap_event_destroy(), wap_event_dump(), and wap_event_name().

Referenced by main_thread().

{
    WSPPushClientMachine *cpm;
    long transid;

    cpm = NULL;
    transid = -1;
   
    switch (e->type) {
    case TR_Invoke_Ind:
         transid = e->u.TR_Invoke_Ind.handle;
    break;

    case S_ConfirmedPush_Res:
         transid = e->u.S_ConfirmedPush_Res.client_push_id;
    break;

    case S_PushAbort_Req:
         transid = e->u.S_PushAbort_Req.push_id;
    break;

    case Abort_Event:
    break;

    case TR_Abort_Ind:
         transid = e->u.TR_Abort_Ind.handle;
    break;

    default:
        debug("wap.wsp", 0, "WSP PUSH: push_client_find_or_create: unhandled"
          " event");
        wap_event_dump(e);
        wap_event_destroy(e);
        return NULL;
    }

    gw_assert(transid != -1);

    cpm = push_client_machine_find_using_transid(transid);
    
    if (cpm == NULL) {
        switch (e->type) {
        case TR_Invoke_Ind:
        cpm = push_client_machine_create(transid);
    break;

        case S_ConfirmedPush_Res:
        case S_PushAbort_Req:
        error(0, "WSP_PUSH_CLIENT: POT primitive to a nonexisting"
                  "  push client machine");
    break;

        case Abort_Event:
        error(0, "WSP_PUSH_CLIENT: internal abort to a nonexisting"
                  " push client machine");
    break;

        case TR_Abort_Ind:
        error(0, "WSP_PUSH_CLIENT: WTP abort to a nonexisting push client"
                  " machine");
    break;

    default:
        error(0, "WSP_PUSH_CLIENT: Cannot handle event type %s",
        wap_event_name(e->type));
    break;
        }
    }

    return cpm;
}

push_client_machine_find_using_transid()

static WSPPushClientMachine* push_client_machine_find_using_transid ( long  transid )

static

Definition at line 287 of file wsp_push_client.c.

References gwlist_search(), push_client_machine_has_transid(), and push_client_machines.

Referenced by push_client_machine_find_or_create().

{
    WSPPushClientMachine *m;
  
    m = gwlist_search(push_client_machines, &transid, 
                    push_client_machine_has_transid);
    return m;
}

push_client_machine_has_transid()

static int push_client_machine_has_transid ( void *  a, void *  b  )

static

Definition at line 277 of file wsp_push_client.c.

Referenced by push_client_machine_find_using_transid().

{
    long transid;
    WSPPushClientMachine *m;

    m = a;
    transid = *(long *)b;
    return m->transaction_id == transid;   
}

response_confirmedpush()

static WAPEvent * response_confirmedpush ( WSPPushClientMachine *  cpm )

static

Definition at line 446 of file wsp_push_client.c.

References WAPEvent::u, and wap_event_create.

{
    WAPEvent *e;

    e = wap_event_create(S_ConfirmedPush_Res);
    e->u.S_ConfirmedPush_Res.client_push_id = cpm->client_push_id;

    return e;
}

response_responder_invoke()

static WAPEvent * response_responder_invoke ( WSPPushClientMachine *  cpm )

static

Definition at line 470 of file wsp_push_client.c.

References WAPEvent::u, and wap_event_create.

{
    WAPEvent *e;

    e = wap_event_create(TR_Invoke_Res);
    e->u.TR_Invoke_Res.handle = cpm->transaction_id;

    return e;
}

send_abort_to_responder()

static WAPEvent * send_abort_to_responder ( WSPPushClientMachine *  cpm, long  reason  )

static

Definition at line 456 of file wsp_push_client.c.

References WAPEvent::u, USER, and wap_event_create.

Referenced by push_client_event_handle().

{
    WAPEvent *e;

    e = wap_event_create(TR_Abort_Req);
    e->u.TR_Abort_Req.abort_type = USER;
    e->u.TR_Abort_Req.abort_reason = reason;
    e->u.TR_Abort_Req.handle = cpm->client_push_id;

    return e;
}

wsp_push_client_dispatch_event()

void wsp_push_client_dispatch_event

(

WAPEvent *

e

)

Definition at line 177 of file wsp_push_client.c.

References gwlist_produce(), and push_client_queue.

Referenced by main().

{
    gwlist_produce(push_client_queue, e);
}

wsp_push_client_init()

void wsp_push_client_init	(	wap_dispatch_func_t *	dispatch_self,
		wap_dispatch_func_t *	dispatch_wtp_resp
	)

Definition at line 145 of file wsp_push_client.c.

References counter_create(), dispatch_to_self, dispatch_to_wtp_resp, gw_assert(), gwlist_add_producer(), gwlist_create, gwthread_create, limbo, main_thread(), push_client_machine_id_counter, push_client_machines, push_client_queue, push_client_run_status, and running.

Referenced by main().

{
    push_client_machines = gwlist_create();
    push_client_machine_id_counter = counter_create();

    push_client_queue = gwlist_create();
    gwlist_add_producer(push_client_queue);

    dispatch_to_self = dispatch_self;
    dispatch_to_wtp_resp = dispatch_wtp_resp;

    gw_assert(push_client_run_status == limbo);
    push_client_run_status = running;
    gwthread_create(main_thread, NULL);
}

wsp_push_client_shutdown()

void wsp_push_client_shutdown

(

void

)

Definition at line 162 of file wsp_push_client.c.

References counter_destroy(), debug(), gw_assert(), gwlist_destroy(), gwlist_len(), gwlist_remove_producer(), gwthread_join_every(), main_thread(), push_client_machine_destroy(), push_client_machine_id_counter, push_client_machines, push_client_queue, push_client_run_status, running, terminating, and wap_event_destroy_item().

Referenced by main().

{
    gw_assert(push_client_run_status == running);
    push_client_run_status = terminating;
    gwlist_remove_producer(push_client_queue);
    gwthread_join_every(main_thread);

    debug("wap.wsp", 0, "wsp_push_client_shutdown: %ld push client machines"
          "left", gwlist_len(push_client_machines));
    gwlist_destroy(push_client_machines, push_client_machine_destroy);
    gwlist_destroy(push_client_queue, wap_event_destroy_item);

    counter_destroy(push_client_machine_id_counter);
}

Variable Documentation

dispatch_to_self

wap_dispatch_func_t* dispatch_to_self

Definition at line 101 of file wsp_push_client.c.

Referenced by wsp_push_client_init().

dispatch_to_wtp_resp

wap_dispatch_func_t* dispatch_to_wtp_resp

Definition at line 102 of file wsp_push_client.c.

Referenced by wsp_push_client_init().

push_client_machine_id_counter

Counter* push_client_machine_id_counter = NULL

static

Definition at line 82 of file wsp_push_client.c.

Referenced by push_client_machine_create(), wsp_push_client_init(), and wsp_push_client_shutdown().

push_client_machines

List* push_client_machines = NULL

static

Definition at line 76 of file wsp_push_client.c.

Referenced by push_client_machine_create(), push_client_machine_destroy(), push_client_machine_find_using_transid(), wsp_push_client_init(), and wsp_push_client_shutdown().

push_client_queue

List* push_client_queue = NULL

static

Definition at line 99 of file wsp_push_client.c.

Referenced by main_thread(), wsp_push_client_dispatch_event(), wsp_push_client_init(), and wsp_push_client_shutdown().

push_client_run_status

enum { ... } push_client_run_status

Referenced by main_thread(), wsp_push_client_init(), and wsp_push_client_shutdown().