sofia-sip/nea.h

Go to the documentation of this file.

/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef NEA_H

#define NEA_H

#ifndef SU_ALLOC_H
#include <sofia-sip/su_alloc.h>
#endif

#include <sofia-sip/su_tag.h>

#ifndef NTA_H
#include <sofia-sip/nta.h>
#endif

#ifndef NEA_TAG_H
#include <sofia-sip/nea_tag.h>
#endif

SOFIA_BEGIN_DECLS

#define NEA_VERSION      3.0
#define NEA_VERSION_STR "3.0"

#define NEA_DEFAULT_EXPIRES 3600

typedef struct nea_server_s     nea_server_t;

typedef struct nea_sub_s        nea_sub_t;

typedef struct nea_event_s      nea_event_t;

typedef struct nea_event_view_s nea_event_view_t;

#ifndef NEA_SMAGIC_T
#define NEA_SMAGIC_T            struct nea_smagic_t
#endif

typedef NEA_SMAGIC_T nea_smagic_t;

#ifndef NEA_EMAGIC_T
#define NEA_EMAGIC_T            struct nea_emagic_t
#endif

typedef NEA_EMAGIC_T nea_emagic_t;

#ifndef NEA_EVMAGIC_T
#define NEA_EVMAGIC_T           struct nea_evmagic_t
#endif

typedef NEA_EVMAGIC_T nea_evmagic_t;

typedef struct nea_subnode_t {
  nea_state_t          sn_state;        
  unsigned             sn_fake;         
  unsigned             sn_eventlist;    
  nea_sub_t           *sn_subscriber;   
  nea_event_t         *sn_event;        
  sip_from_t const    *sn_remote;       
  sip_contact_t const *sn_contact;      
  sip_content_type_t const *sn_content_type;
  sip_payload_t const *sn_payload;      
  unsigned             sn_expires;      
  unsigned             sn_latest;       
  unsigned             sn_throttle;     
  unsigned             sn_version;      
  sip_time_t           sn_notified;     
  sip_time_t           sn_subscribed;   
  nea_event_view_t    *sn_view;         
} nea_subnode_t;

typedef struct nea_payloads_s   nea_payloads_t;

typedef int (nea_new_event_f)(nea_smagic_t *context,
                              nea_server_t *nes,
                              nea_event_t **event_p,
                              nea_event_view_t **view_p,
                              nta_incoming_t *irq,
                              sip_t const *sip);

SOFIAPUBFUN
nea_server_t *nea_server_create(nta_agent_t *agent,
                                su_root_t *root,
                                url_t const *url,
                                int max_subs,
                                nea_new_event_f *callback,
                                nea_smagic_t *context,
                                tag_type_t tag, tag_value_t value,
                                ...);


SOFIAPUBFUN int nea_server_shutdown(nea_server_t *nes, int retry_after);

SOFIAPUBFUN void nea_server_destroy(nea_server_t *nes);

SOFIAPUBFUN void nea_server_flush(nea_server_t *nes, nea_event_t *event);

SOFIAPUBFUN
int nea_server_update(nea_server_t *nes,
                      nea_event_t *ev,
                      tag_type_t tag,
                      tag_value_t value,
                      ...);

SOFIAPUBFUN
int nea_server_add_irq(nea_server_t *nes,
                       nta_leg_t *leg,
                       sip_contact_t const *local_target,
                       nta_incoming_t *irq,
                       sip_t const *sip);

typedef void (nea_watcher_f)(nea_server_t *nes,
                             nea_emagic_t *context,
                             nea_event_t *event,
                             nea_subnode_t *subnode,
                             sip_t const *sip);

SOFIAPUBFUN
nea_event_t *nea_event_create(nea_server_t *nes,
                              nea_watcher_f *callback,
                              nea_emagic_t *context,
                              char const *name,
                              char const *subname,
                              char const *default_content_type,
                              char const *accept);

SOFIAPUBFUN
nea_event_t *nea_event_tcreate(nea_server_t *nes,
                               nea_watcher_f *callback,
                               nea_emagic_t *context,
                               char const *name,
                               char const *subname,
                               tag_type_t, tag_value_t, ...);

SOFIAPUBFUN nea_emagic_t *nea_emagic_get(nea_event_t *event);

SOFIAPUBFUN nea_event_t *nea_event_get(nea_server_t const *, char const *name);

SOFIAPUBFUN int nea_server_active(nea_server_t *nes, nea_event_t const *ev);

int nea_server_non_embryonic(nea_server_t *nes, nea_event_t const *ev);

SOFIAPUBFUN
nea_subnode_t const **nea_server_get_subscribers(nea_server_t *nes,
                                                 nea_event_t const *ev);

SOFIAPUBFUN
void nea_server_free_subscribers(nea_server_t *nes, nea_subnode_t const **);

SOFIAPUBFUN
int nea_server_notify(nea_server_t *nes,
                      nea_event_t *ev);

SOFIAPUBFUN
int nea_server_notify_one(nea_server_t *nes,
                          nea_event_t *ev,
                          nea_sub_t *ns);

#define nea_server_auth nea_sub_auth

SOFIAPUBFUN nta_incoming_t *nea_sub_get_request(nea_sub_t *sub);

SOFIAPUBFUN
int nea_sub_auth(nea_sub_t *, nea_state_t state,
                 tag_type_t, tag_value_t, ...);

SOFIAPUBFUN nta_incoming_t *nea_subnode_get_incoming(nea_subnode_t *sn);
SOFIAPUBFUN int nea_sub_version(nea_sub_t *, unsigned);

SOFIAPUBFUN unsigned nea_sub_pending(nea_sub_t const *);

#if 0

void nea_server_qauth(nea_server_t *nes,
                      nea_emagic_t *context,
                      nea_sub_t *subscriber,
                      sip_t const *sip);
#endif

SOFIAPUBFUN
nea_event_view_t *nea_event_view(nea_event_t *, char const *content_type);

SOFIAPUBFUN
sip_content_type_t const *nea_view_content_type(nea_event_view_t const *);

SOFIAPUBFUN sip_payload_t const *nea_view_payload(nea_event_view_t *);

SOFIAPUBFUN nea_event_view_t *nea_view_create(nea_server_t *nes,
                                              nea_event_t *ev,
                                              nea_evmagic_t *magic,
                                              tag_type_t tag,
                                              tag_value_t value,
                                              ...);

SOFIAPUBFUN void nea_view_destroy(nea_server_t *nes, nea_event_view_t *ev);

SOFIAPUBFUN nea_evmagic_t *nea_view_magic(nea_event_view_t const *);

SOFIAPUBFUN void nea_view_set_magic(nea_event_view_t *, nea_evmagic_t *magic);

SOFIAPUBFUN unsigned nea_view_version(nea_event_view_t const *);

#define NEATAG_RELIABLE(x)    neatag_reliable, tag_bool_v((x))
SOFIAPUBVAR tag_typedef_t neatag_reliable;

#define NEATAG_RELIABLE_REF(x) neatag_reliable_ref, tag_bool_vr((&x))
SOFIAPUBVAR tag_typedef_t neatag_reliable_ref;

#define NEATAG_VIEW(x)     neatag_view, tag_ptr_v((x))
SOFIAPUBVAR tag_typedef_t neatag_view;

#define NEATAG_VIEW_REF(x) neatag_view_ref, tag_ptr_vr((&x), (x))
SOFIAPUBVAR tag_typedef_t neatag_view_ref;

#define NEATAG_EVMAGIC(x)     neatag_evmagic, tag_ptr_v((x))
SOFIAPUBVAR tag_typedef_t neatag_evmagic;

#define NEATAG_EVMAGIC_REF(x) neatag_evmagic_ref, tag_ptr_vr((&x), (x))
SOFIAPUBVAR tag_typedef_t neatag_evmagic_ref;

#define NEATAG_SUB(x)     neatag_sub, tag_ptr_v((x))
SOFIAPUBVAR tag_typedef_t neatag_sub;

#define NEATAG_SUB_REF(x) neatag_sub_ref, tag_ptr_vr((&x), (x))
SOFIAPUBVAR tag_typedef_t neatag_sub_ref;


/* ====================================================================== */
/* Watcher side */

typedef struct nea_s     nea_t;

#ifndef NEA_MAGIC_T
#define NEA_MAGIC_T struct nea_magic_t
#endif

typedef NEA_MAGIC_T          nea_magic_t;

typedef int (*nea_notify_f)(nea_t *nea,
                            nea_magic_t *context,
                            sip_t const *sip);

/* ====================================================================== */
/* Client side */

SOFIAPUBFUN
nea_t *nea_create(nta_agent_t *agent,
                  su_root_t *root,
                  nea_notify_f no_callback,
                  nea_magic_t *context,
                  tag_type_t tag,
                  tag_value_t value,
                  ...);

SOFIAPUBFUN
int nea_update(nea_t *nea,
               tag_type_t tag,
               tag_value_t value,
               ...);

SOFIAPUBFUN void nea_end(nea_t *agent);

SOFIAPUBFUN void nea_destroy(nea_t *agent);

SOFIAPUBFUN char const *nea_default_content_type(char const *event);

SOFIA_END_DECLS

#endif /* !defined(NEA_H) */