sofia-sip/nta.h

Go to the documentation of this file.
00001 /*
00002  * This file is part of the Sofia-SIP package
00003  *
00004  * Copyright (C) 2005 Nokia Corporation.
00005  *
00006  * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
00007  *
00008  * This library is free software; you can redistribute it and/or
00009  * modify it under the terms of the GNU Lesser General Public License
00010  * as published by the Free Software Foundation; either version 2.1 of
00011  * the License, or (at your option) any later version.
00012  *
00013  * This library is distributed in the hope that it will be useful, but
00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00016  * Lesser General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU Lesser General Public
00019  * License along with this library; if not, write to the Free Software
00020  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
00021  * 02110-1301 USA
00022  *
00023  */
00024 
00025 #ifndef NTA_H
00026 
00027 #define NTA_H
00028 
00036 #ifndef SU_WAIT_H
00037 #include <sofia-sip/su_wait.h>
00038 #endif
00039 
00040 #ifndef SIP_H
00041 #include <sofia-sip/sip.h>
00042 #endif
00043 
00044 #ifndef NTA_TAG_H
00045 #include <sofia-sip/nta_tag.h>
00046 #endif
00047 
00048 SOFIA_BEGIN_DECLS
00049 
00050 /* ----------------------------------------------------------------------
00051  * 1) Types 
00052  */
00053 
00055 typedef struct nta_agent_s      nta_agent_t;
00057 typedef struct nta_leg_s        nta_leg_t;
00059 typedef struct nta_outgoing_s   nta_outgoing_t;
00061 typedef struct nta_incoming_s   nta_incoming_t;
00062 
00063 #ifndef NTA_AGENT_MAGIC_T
00064 
00067 #define NTA_AGENT_MAGIC_T struct nta_agent_magic_s
00068 #endif
00069 #ifndef NTA_LEG_MAGIC_T
00070 
00073 #define NTA_LEG_MAGIC_T struct nta_leg_magic_s
00074 #endif
00075 #ifndef NTA_OUTGOING_MAGIC_T
00076 
00079 #define NTA_OUTGOING_MAGIC_T struct nta_outgoing_magic_s
00080 #endif
00081 #ifndef NTA_INCOMING_MAGIC_T
00082 
00085 #define NTA_INCOMING_MAGIC_T struct nta_incoming_magic_s
00086 #endif
00087 
00089 typedef NTA_AGENT_MAGIC_T     nta_agent_magic_t;
00091 typedef NTA_LEG_MAGIC_T       nta_leg_magic_t;
00093 typedef NTA_OUTGOING_MAGIC_T  nta_outgoing_magic_t;
00095 typedef NTA_INCOMING_MAGIC_T  nta_incoming_magic_t;
00096 
00097 /* ----------------------------------------------------------------------
00098  * 2) Constants 
00099  */
00100 
00102 #define NTA_VERSION "2.0"
00103 
00105 SOFIAPUBVAR char const nta_version[];
00106 
00107 enum {
00108   /* Stack parameters */
00109   NTA_SIP_T1 = 500,             
00110   NTA_SIP_T2 = 4000,            
00111   NTA_SIP_T4 = 5000,            
00112   NTA_TIME_MAX = 15 * 24 * 3600 * 1000
00114 };
00115 
00116 /* ----------------------------------------------------------------------
00117  * 3) Agent-level prototypes
00118  */
00119 
00120 typedef int nta_message_f(nta_agent_magic_t *context,
00121                           nta_agent_t *agent,
00122                           msg_t *msg,
00123                           sip_t *sip);
00124 
00125 SOFIAPUBFUN 
00126 nta_agent_t *nta_agent_create(su_root_t *root,
00127                               url_string_t const *name,
00128                               nta_message_f *callback,
00129                               nta_agent_magic_t *magic,
00130                               tag_type_t tag, tag_value_t value, ...);
00131 
00132 SOFIAPUBFUN void nta_agent_destroy(nta_agent_t *agent);
00133 
00134 SOFIAPUBFUN char const *nta_agent_version(nta_agent_t const *a);
00135 SOFIAPUBFUN nta_agent_magic_t *nta_agent_magic(nta_agent_t const *a);
00136 
00137 SOFIAPUBFUN
00138 int nta_agent_add_tport(nta_agent_t *agent,
00139                         url_string_t const *url,
00140                         tag_type_t tag, tag_value_t value, ...);
00141 
00142 SOFIAPUBFUN sip_contact_t *nta_agent_contact(nta_agent_t const *a);
00143 SOFIAPUBFUN sip_via_t *nta_agent_via(nta_agent_t const *a);
00144 SOFIAPUBFUN sip_via_t *nta_agent_public_via(nta_agent_t const *a);
00145 
00146 SOFIAPUBFUN char const *nta_agent_newtag(su_home_t *,
00147                                          char const *fmt, nta_agent_t *);
00148 
00149 SOFIAPUBFUN int nta_agent_set_params(nta_agent_t *agent, 
00150                                      tag_type_t tag, tag_value_t value, ...);
00151 SOFIAPUBFUN int nta_agent_get_params(nta_agent_t *agent, 
00152                                      tag_type_t tag, tag_value_t value, ...);
00153 
00154 SOFIAPUBFUN int nta_agent_get_stats(nta_agent_t *agent, 
00155                                     tag_type_t tag, tag_value_t value, ...);
00156 
00157 /* ----------------------------------------------------------------------
00158  * 4) Message-level prototypes
00159  */
00160 
00161 SOFIAPUBFUN msg_t *nta_msg_create(nta_agent_t *self, int flags);
00162 
00163 SOFIAPUBFUN int nta_msg_complete(msg_t *msg);
00164 
00165 SOFIAPUBFUN int nta_msg_request_complete(msg_t *msg, 
00166                                          nta_leg_t *leg, 
00167                                          sip_method_t method, 
00168                                          char const *method_name,
00169                                          url_string_t const *req_url);
00170 
00171 SOFIAPUBFUN int nta_is_internal_msg(msg_t const *msg);
00172 
00173 /* ----------------------------------------------------------------------
00174  * 5) Leg-level prototypes
00175  */
00176 typedef int nta_request_f(nta_leg_magic_t *lmagic, 
00177                           nta_leg_t *leg,
00178                           nta_incoming_t *irq, 
00179                           sip_t const *sip);
00180 
00181 SOFIAPUBFUN 
00182 nta_leg_t *nta_leg_tcreate(nta_agent_t *agent,  
00183                            nta_request_f *req_callback,
00184                            nta_leg_magic_t *magic,
00185                            tag_type_t tag, tag_value_t value, ...);
00186 
00187 SOFIAPUBFUN void nta_leg_destroy(nta_leg_t *leg);
00188 
00189 SOFIAPUBFUN nta_leg_t *nta_default_leg(nta_agent_t const *agent);
00190 
00191 SOFIAPUBFUN nta_leg_magic_t *nta_leg_magic(nta_leg_t const *leg,
00192                                            nta_request_f *callback);
00193 
00194 SOFIAPUBFUN void nta_leg_bind(nta_leg_t *leg,
00195                               nta_request_f *callback,
00196                               nta_leg_magic_t *);
00197 
00199 SOFIAPUBFUN char const *nta_leg_tag(nta_leg_t *leg, char const *tag);
00200 
00202 SOFIAPUBFUN char const *nta_leg_get_tag(nta_leg_t const *leg);
00203 
00205 SOFIAPUBFUN char const *nta_leg_rtag(nta_leg_t *leg, char const *tag);
00206 
00208 SOFIAPUBFUN char const *nta_leg_get_rtag(nta_leg_t const *leg);
00209 
00211 SOFIAPUBFUN int nta_leg_client_route(nta_leg_t *leg, 
00212                                      sip_record_route_t const *route, 
00213                                      sip_contact_t const *contact);
00214 
00216 SOFIAPUBFUN int nta_leg_server_route(nta_leg_t *leg, 
00217                                      sip_record_route_t const *route, 
00218                                      sip_contact_t const *contact);
00219 
00221 SOFIAPUBFUN int nta_leg_get_route(nta_leg_t *leg, 
00222                                   sip_route_t const **return_route, 
00223                                   sip_contact_t const **return_target);
00224 
00226 SOFIAPUBFUN nta_leg_t *nta_leg_by_uri(nta_agent_t const *,
00227                                       url_string_t const *);
00228 
00230 SOFIAPUBFUN
00231 nta_leg_t *nta_leg_by_dialog(nta_agent_t const *agent, 
00232                              url_t const *request_uri,
00233                              sip_call_id_t const *call_id,
00234                              char const *from_tag,
00235                              url_t const *from_url,
00236                              char const *to_tag,
00237                              url_t const *to_url);
00238 
00239 /* ----------------------------------------------------------------------
00240  * 6) Prototypes for incoming transactions 
00241  */
00242 
00243 SOFIAPUBFUN
00244 nta_incoming_t *nta_incoming_create(nta_agent_t *agent,
00245                                     nta_leg_t *leg,
00246                                     msg_t *msg,
00247                                     sip_t *sip,
00248                                     tag_type_t tag, tag_value_t value, ...);
00249 
00250 SOFIAPUBFUN nta_incoming_t *nta_incoming_default(nta_agent_t *agent);
00251 
00252 typedef int nta_ack_cancel_f(nta_incoming_magic_t *imagic,
00253                              nta_incoming_t *irq, 
00254                              sip_t const *sip);
00255 
00256 SOFIAPUBFUN void nta_incoming_bind(nta_incoming_t *irq, 
00257                                    nta_ack_cancel_f *callback,
00258                                    nta_incoming_magic_t *imagic);
00259 
00260 SOFIAPUBFUN
00261 nta_incoming_magic_t *nta_incoming_magic(nta_incoming_t *irq, 
00262                                          nta_ack_cancel_f *callback);
00263 
00264 SOFIAPUBFUN
00265 nta_incoming_t *nta_incoming_find(nta_agent_t const *agent, 
00266                                   sip_t const *sip,
00267                                   sip_via_t const *v);
00268 
00269 SOFIAPUBFUN char const *nta_incoming_tag(nta_incoming_t *irq, char const *tag);
00270 SOFIAPUBFUN char const *nta_incoming_gettag(nta_incoming_t const *irq);
00271 
00272 SOFIAPUBFUN int nta_incoming_status(nta_incoming_t const *irq);
00273 SOFIAPUBFUN sip_method_t nta_incoming_method(nta_incoming_t const *irq);
00274 SOFIAPUBFUN char const *nta_incoming_method_name(nta_incoming_t const *irq);
00275 SOFIAPUBFUN url_t const *nta_incoming_url(nta_incoming_t const *irq);
00276 SOFIAPUBFUN uint32_t nta_incoming_cseq(nta_incoming_t const *irq);
00277 
00278 SOFIAPUBFUN int nta_incoming_set_params(nta_incoming_t *irq,
00279                                         tag_type_t tag, tag_value_t value, ...);
00280 
00281 SOFIAPUBFUN msg_t *nta_incoming_getrequest(nta_incoming_t *irq);
00282 SOFIAPUBFUN msg_t *nta_incoming_getrequest_ackcancel(nta_incoming_t *irq);
00283 SOFIAPUBFUN msg_t *nta_incoming_getresponse(nta_incoming_t *irq);
00284 
00285 SOFIAPUBFUN
00286 int nta_incoming_complete_response(nta_incoming_t *irq,
00287                                    msg_t *msg,
00288                                    int status, 
00289                                    char const *phrase,
00290                                    tag_type_t tag, tag_value_t value, ...);
00291 
00292 SOFIAPUBFUN
00293 int nta_incoming_treply(nta_incoming_t *ireq, 
00294                         int status, char const *phrase, 
00295                         tag_type_t tag, tag_value_t value, ...);
00296 
00297 SOFIAPUBFUN int nta_incoming_mreply(nta_incoming_t *irq, msg_t *msg);
00298 
00299 SOFIAPUBFUN void nta_incoming_destroy(nta_incoming_t *irq);
00300 
00301 /* Functions for feature, method, mime, session-timer negotation */
00302 
00303 SOFIAPUBFUN
00304 int nta_check_required(nta_incoming_t *irq,
00305                        sip_t const *sip,
00306                        sip_supported_t const *supported,
00307                        tag_type_t tag, tag_value_t value, ...);
00308 SOFIAPUBFUN
00309 int nta_check_supported(nta_incoming_t *irq,
00310                         sip_t const *sip,
00311                         sip_require_t *require,
00312                         tag_type_t tag, tag_value_t value, ...);
00313 SOFIAPUBFUN
00314 int nta_check_method(nta_incoming_t *irq,
00315                      sip_t const *sip,
00316                      sip_allow_t const *allow,
00317                      tag_type_t tag, tag_value_t value, ...);
00318 SOFIAPUBFUN
00319 int nta_check_session_content(nta_incoming_t *irq, sip_t const *sip,
00320                               sip_accept_t const *session_accepts,
00321                               tag_type_t tag, tag_value_t value, ...);
00322 SOFIAPUBFUN
00323 int nta_check_accept(nta_incoming_t *irq,
00324                      sip_t const *sip,
00325                      sip_accept_t const *acceptable,
00326                      sip_accept_t const **return_acceptable,
00327                      tag_type_t tag, tag_value_t value, ...);
00328 
00329 SOFIAPUBFUN
00330 int nta_check_session_expires(nta_incoming_t *irq,
00331                               sip_t const *sip,
00332                               sip_time_t my_min_se,
00333                               tag_type_t tag, tag_value_t value, ...);
00334 
00335 /* ----------------------------------------------------------------------
00336  * 7) Prototypes for outgoing transactions
00337  */
00338 typedef int nta_response_f(nta_outgoing_magic_t *magic,
00339                            nta_outgoing_t *request,
00340                            sip_t const *sip);
00341 
00342 SOFIAPUBFUN
00343 nta_outgoing_t *nta_outgoing_tcreate(nta_leg_t *leg,
00344                                      nta_response_f *callback,
00345                                      nta_outgoing_magic_t *magic,
00346                                      url_string_t const *route_url,
00347                                      sip_method_t method,
00348                                      char const *method_name,
00349                                      url_string_t const *request_uri,
00350                                      tag_type_t tag, tag_value_t value, ...);
00351 
00352 SOFIAPUBFUN
00353 nta_outgoing_t *nta_outgoing_mcreate(nta_agent_t *agent,
00354                                      nta_response_f *callback,
00355                                      nta_outgoing_magic_t *magic,
00356                                      url_string_t const *route_url, 
00357                                      msg_t *msg,
00358                                      tag_type_t tag, tag_value_t value, ...);
00359 
00360 SOFIAPUBFUN
00361 nta_outgoing_t *nta_outgoing_default(nta_agent_t *agent,
00362                                      nta_response_f *callback,
00363                                      nta_outgoing_magic_t *magic);
00364 
00365 SOFIAPUBFUN int nta_outgoing_status(nta_outgoing_t const *orq);
00366 SOFIAPUBFUN sip_method_t nta_outgoing_method(nta_outgoing_t const *orq);
00367 SOFIAPUBFUN char const *nta_outgoing_method_name(nta_outgoing_t const *orq);
00368 SOFIAPUBFUN uint32_t nta_outgoing_cseq(nta_outgoing_t const *orq);
00369 
00370 SOFIAPUBFUN unsigned nta_outgoing_delay(nta_outgoing_t const *orq);
00371 
00372 SOFIAPUBFUN url_t const *nta_outgoing_request_uri(nta_outgoing_t const *orq);
00373 SOFIAPUBFUN url_t const *nta_outgoing_route_uri(nta_outgoing_t const *orq);
00374 
00375 SOFIAPUBFUN msg_t *nta_outgoing_getresponse(nta_outgoing_t *orq);
00376 SOFIAPUBFUN msg_t *nta_outgoing_getrequest(nta_outgoing_t *orq);
00377 
00378 SOFIAPUBFUN
00379 nta_outgoing_t *nta_outgoing_tagged(nta_outgoing_t *orq, 
00380                                     nta_response_f *callback,
00381                                     nta_outgoing_magic_t *magic,
00382                                     char const *to_tag,
00383                                     sip_rseq_t const *rseq);
00384 
00385 SOFIAPUBFUN int nta_outgoing_cancel(nta_outgoing_t *);
00386 
00387 SOFIAPUBFUN
00388 nta_outgoing_t *nta_outgoing_tcancel(nta_outgoing_t *orq, 
00389                                      nta_response_f *callback,
00390                                      nta_outgoing_magic_t *magic,
00391                                      tag_type_t, tag_value_t, ...);
00392 
00393 SOFIAPUBFUN void nta_outgoing_destroy(nta_outgoing_t *);
00394 
00395 SOFIAPUBFUN
00396 nta_outgoing_t *nta_outgoing_find(nta_agent_t const *sa,
00397                                   msg_t const *msg,
00398                                   sip_t const *sip, 
00399                                   sip_via_t const *v);
00400 
00401 SOFIAPUBFUN int nta_tport_keepalive(nta_outgoing_t *orq);
00402 
00403 /* ----------------------------------------------------------------------
00404  * 8) Reliable provisional responses (100rel)
00405  */
00406 
00407 /* UAC side */
00408 
00409 SOFIAPUBFUN
00410 nta_outgoing_t *nta_outgoing_prack(nta_leg_t *leg,
00411                                    nta_outgoing_t *oorq,
00412                                    nta_response_f *callback,
00413                                    nta_outgoing_magic_t *magic,
00414                                    url_string_t const *route_url,
00415                                    sip_t const *response_to_prack,
00416                                    tag_type_t, tag_value_t, ...);
00417 
00418 SOFIAPUBFUN uint32_t nta_outgoing_rseq(nta_outgoing_t const *orq);
00419 SOFIAPUBFUN int nta_outgoing_setrseq(nta_outgoing_t *orq, uint32_t rseq);
00420 
00421 /* UAS side */
00422 
00424 typedef struct nta_reliable_s   nta_reliable_t;
00425 
00426 #ifndef NTA_RELIABLE_MAGIC_T
00427 
00430 #define NTA_RELIABLE_MAGIC_T struct nta_reliable_magic_s
00431 #endif
00432 
00434 typedef NTA_RELIABLE_MAGIC_T  nta_reliable_magic_t;
00435 
00436 typedef int nta_prack_f(nta_reliable_magic_t *rmagic,
00437                         nta_reliable_t *rel,
00438                         nta_incoming_t *prack, 
00439                         sip_t const *sip);
00440 
00441 SOFIAPUBFUN
00442 nta_reliable_t *nta_reliable_treply(nta_incoming_t *ireq,
00443                                     nta_prack_f *callback,
00444                                     nta_reliable_magic_t *rmagic,
00445                                     int status, char const *phrase, 
00446                                     tag_type_t tag, 
00447                                     tag_value_t value, ...);
00448 
00449 SOFIAPUBFUN
00450 nta_reliable_t *nta_reliable_mreply(nta_incoming_t *irq, 
00451                                     nta_prack_f *callback,
00452                                     nta_reliable_magic_t *rmagic,
00453                                     msg_t *msg);
00454 
00455 SOFIAPUBFUN void nta_reliable_destroy(nta_reliable_t *);
00456 
00457 /* ----------------------------------------------------------------------
00458  * Backward-compatibility stuff - going away soon
00459  */
00460 
00461 #define nta_outgoing_tmcreate nta_outgoing_mcreate
00462 #define nta_msg_response_complete(msg, irq, status, phrase) \
00463   nta_incoming_complete_response((irq), (msg), (status), (phrase), TAG_END())
00464 
00465 SOFIAPUBFUN void nta_msg_discard(nta_agent_t *agent, msg_t *msg);
00466 
00467 SOFIA_END_DECLS
00468 
00469 #endif

Sofia-SIP 1.12.1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.