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 int nta_agent_close_tports(nta_agent_t *agent);
00143 
00144 SOFIAPUBFUN sip_contact_t *nta_agent_contact(nta_agent_t const *a);
00145 SOFIAPUBFUN sip_via_t *nta_agent_via(nta_agent_t const *a);
00146 SOFIAPUBFUN sip_via_t *nta_agent_public_via(nta_agent_t const *a);
00147 
00148 SOFIAPUBFUN char const *nta_agent_newtag(su_home_t *,
00149                                          char const *fmt, nta_agent_t *);
00150 
00151 SOFIAPUBFUN int nta_agent_set_params(nta_agent_t *agent, 
00152                                      tag_type_t tag, tag_value_t value, ...);
00153 SOFIAPUBFUN int nta_agent_get_params(nta_agent_t *agent, 
00154                                      tag_type_t tag, tag_value_t value, ...);
00155 
00156 SOFIAPUBFUN int nta_agent_get_stats(nta_agent_t *agent, 
00157                                     tag_type_t tag, tag_value_t value, ...);
00158 
00159 /* ----------------------------------------------------------------------
00160  * 4) Message-level prototypes
00161  */
00162 
00163 SOFIAPUBFUN msg_t *nta_msg_create(nta_agent_t *self, int flags);
00164 
00165 SOFIAPUBFUN int nta_msg_complete(msg_t *msg);
00166 
00167 SOFIAPUBFUN int nta_msg_request_complete(msg_t *msg, 
00168                                          nta_leg_t *leg, 
00169                                          sip_method_t method, 
00170                                          char const *method_name,
00171                                          url_string_t const *req_url);
00172 
00173 SOFIAPUBFUN int nta_is_internal_msg(msg_t const *msg);
00174 
00175 /* ----------------------------------------------------------------------
00176  * 5) Leg-level prototypes
00177  */
00178 typedef int nta_request_f(nta_leg_magic_t *lmagic, 
00179                           nta_leg_t *leg,
00180                           nta_incoming_t *irq, 
00181                           sip_t const *sip);
00182 
00183 SOFIAPUBFUN 
00184 nta_leg_t *nta_leg_tcreate(nta_agent_t *agent,  
00185                            nta_request_f *req_callback,
00186                            nta_leg_magic_t *magic,
00187                            tag_type_t tag, tag_value_t value, ...);
00188 
00189 SOFIAPUBFUN void nta_leg_destroy(nta_leg_t *leg);
00190 
00191 SOFIAPUBFUN nta_leg_t *nta_default_leg(nta_agent_t const *agent);
00192 
00193 SOFIAPUBFUN nta_leg_magic_t *nta_leg_magic(nta_leg_t const *leg,
00194                                            nta_request_f *callback);
00195 
00196 SOFIAPUBFUN void nta_leg_bind(nta_leg_t *leg,
00197                               nta_request_f *callback,
00198                               nta_leg_magic_t *);
00199 
00201 SOFIAPUBFUN char const *nta_leg_tag(nta_leg_t *leg, char const *tag);
00202 
00204 SOFIAPUBFUN char const *nta_leg_get_tag(nta_leg_t const *leg);
00205 
00207 SOFIAPUBFUN char const *nta_leg_rtag(nta_leg_t *leg, char const *tag);
00208 
00210 SOFIAPUBFUN char const *nta_leg_get_rtag(nta_leg_t const *leg);
00211 
00213 SOFIAPUBFUN int nta_leg_client_route(nta_leg_t *leg, 
00214                                      sip_record_route_t const *route, 
00215                                      sip_contact_t const *contact);
00216 
00218 SOFIAPUBFUN int nta_leg_server_route(nta_leg_t *leg, 
00219                                      sip_record_route_t const *route, 
00220                                      sip_contact_t const *contact);
00221 
00223 SOFIAPUBFUN int nta_leg_get_route(nta_leg_t *leg, 
00224                                   sip_route_t const **return_route, 
00225                                   sip_contact_t const **return_target);
00226 
00228 SOFIAPUBFUN nta_leg_t *nta_leg_by_uri(nta_agent_t const *,
00229                                       url_string_t const *);
00230 
00232 SOFIAPUBFUN
00233 nta_leg_t *nta_leg_by_dialog(nta_agent_t const *agent, 
00234                              url_t const *request_uri,
00235                              sip_call_id_t const *call_id,
00236                              char const *from_tag,
00237                              url_t const *from_url,
00238                              char const *to_tag,
00239                              url_t const *to_url);
00240 
00242 SOFIAPUBFUN sip_replaces_t *nta_leg_make_replaces(nta_leg_t *leg,
00243                                                   su_home_t *home,
00244                                                   int early_only);
00246 SOFIAPUBFUN
00247 nta_leg_t *nta_leg_by_replaces(nta_agent_t *, sip_replaces_t const *);
00248 
00249 /* ----------------------------------------------------------------------
00250  * 6) Prototypes for incoming transactions 
00251  */
00252 
00253 SOFIAPUBFUN
00254 nta_incoming_t *nta_incoming_create(nta_agent_t *agent,
00255                                     nta_leg_t *leg,
00256                                     msg_t *msg,
00257                                     sip_t *sip,
00258                                     tag_type_t tag, tag_value_t value, ...);
00259 
00260 SOFIAPUBFUN nta_incoming_t *nta_incoming_default(nta_agent_t *agent);
00261 
00262 typedef int nta_ack_cancel_f(nta_incoming_magic_t *imagic,
00263                              nta_incoming_t *irq, 
00264                              sip_t const *sip);
00265 
00266 SOFIAPUBFUN void nta_incoming_bind(nta_incoming_t *irq, 
00267                                    nta_ack_cancel_f *callback,
00268                                    nta_incoming_magic_t *imagic);
00269 
00270 SOFIAPUBFUN
00271 nta_incoming_magic_t *nta_incoming_magic(nta_incoming_t *irq, 
00272                                          nta_ack_cancel_f *callback);
00273 
00274 SOFIAPUBFUN
00275 nta_incoming_t *nta_incoming_find(nta_agent_t const *agent, 
00276                                   sip_t const *sip,
00277                                   sip_via_t const *v);
00278 
00279 SOFIAPUBFUN char const *nta_incoming_tag(nta_incoming_t *irq, char const *tag);
00280 SOFIAPUBFUN char const *nta_incoming_gettag(nta_incoming_t const *irq);
00281 
00282 SOFIAPUBFUN int nta_incoming_status(nta_incoming_t const *irq);
00283 SOFIAPUBFUN sip_method_t nta_incoming_method(nta_incoming_t const *irq);
00284 SOFIAPUBFUN char const *nta_incoming_method_name(nta_incoming_t const *irq);
00285 SOFIAPUBFUN url_t const *nta_incoming_url(nta_incoming_t const *irq);
00286 SOFIAPUBFUN uint32_t nta_incoming_cseq(nta_incoming_t const *irq);
00287 
00288 SOFIAPUBFUN int nta_incoming_set_params(nta_incoming_t *irq,
00289                                         tag_type_t tag, tag_value_t value, ...);
00290 
00291 SOFIAPUBFUN msg_t *nta_incoming_getrequest(nta_incoming_t *irq);
00292 SOFIAPUBFUN msg_t *nta_incoming_getrequest_ackcancel(nta_incoming_t *irq);
00293 SOFIAPUBFUN msg_t *nta_incoming_getresponse(nta_incoming_t *irq);
00294 
00295 SOFIAPUBFUN
00296 int nta_incoming_complete_response(nta_incoming_t *irq,
00297                                    msg_t *msg,
00298                                    int status, 
00299                                    char const *phrase,
00300                                    tag_type_t tag, tag_value_t value, ...);
00301 
00302 SOFIAPUBFUN
00303 int nta_incoming_treply(nta_incoming_t *ireq, 
00304                         int status, char const *phrase, 
00305                         tag_type_t tag, tag_value_t value, ...);
00306 
00307 SOFIAPUBFUN int nta_incoming_mreply(nta_incoming_t *irq, msg_t *msg);
00308 
00309 SOFIAPUBFUN void nta_incoming_destroy(nta_incoming_t *irq);
00310 
00311 /* Functions for feature, method, mime, session-timer negotation */
00312 
00313 SOFIAPUBFUN
00314 int nta_check_required(nta_incoming_t *irq,
00315                        sip_t const *sip,
00316                        sip_supported_t const *supported,
00317                        tag_type_t tag, tag_value_t value, ...);
00318 SOFIAPUBFUN
00319 int nta_check_supported(nta_incoming_t *irq,
00320                         sip_t const *sip,
00321                         sip_require_t *require,
00322                         tag_type_t tag, tag_value_t value, ...);
00323 SOFIAPUBFUN
00324 int nta_check_method(nta_incoming_t *irq,
00325                      sip_t const *sip,
00326                      sip_allow_t const *allow,
00327                      tag_type_t tag, tag_value_t value, ...);
00328 SOFIAPUBFUN
00329 int nta_check_session_content(nta_incoming_t *irq, sip_t const *sip,
00330                               sip_accept_t const *session_accepts,
00331                               tag_type_t tag, tag_value_t value, ...);
00332 SOFIAPUBFUN
00333 int nta_check_accept(nta_incoming_t *irq,
00334                      sip_t const *sip,
00335                      sip_accept_t const *acceptable,
00336                      sip_accept_t const **return_acceptable,
00337                      tag_type_t tag, tag_value_t value, ...);
00338 
00339 SOFIAPUBFUN
00340 int nta_check_session_expires(nta_incoming_t *irq,
00341                               sip_t const *sip,
00342                               sip_time_t my_min_se,
00343                               tag_type_t tag, tag_value_t value, ...);
00344 
00345 /* ----------------------------------------------------------------------
00346  * 7) Prototypes for outgoing transactions
00347  */
00348 typedef int nta_response_f(nta_outgoing_magic_t *magic,
00349                            nta_outgoing_t *request,
00350                            sip_t const *sip);
00351 
00352 SOFIAPUBFUN
00353 nta_outgoing_t *nta_outgoing_tcreate(nta_leg_t *leg,
00354                                      nta_response_f *callback,
00355                                      nta_outgoing_magic_t *magic,
00356                                      url_string_t const *route_url,
00357                                      sip_method_t method,
00358                                      char const *method_name,
00359                                      url_string_t const *request_uri,
00360                                      tag_type_t tag, tag_value_t value, ...);
00361 
00362 SOFIAPUBFUN
00363 nta_outgoing_t *nta_outgoing_mcreate(nta_agent_t *agent,
00364                                      nta_response_f *callback,
00365                                      nta_outgoing_magic_t *magic,
00366                                      url_string_t const *route_url, 
00367                                      msg_t *msg,
00368                                      tag_type_t tag, tag_value_t value, ...);
00369 
00370 SOFIAPUBFUN
00371 nta_outgoing_t *nta_outgoing_default(nta_agent_t *agent,
00372                                      nta_response_f *callback,
00373                                      nta_outgoing_magic_t *magic);
00374 
00375 SOFIAPUBFUN int nta_outgoing_status(nta_outgoing_t const *orq);
00376 SOFIAPUBFUN sip_method_t nta_outgoing_method(nta_outgoing_t const *orq);
00377 SOFIAPUBFUN char const *nta_outgoing_method_name(nta_outgoing_t const *orq);
00378 SOFIAPUBFUN uint32_t nta_outgoing_cseq(nta_outgoing_t const *orq);
00379 
00380 SOFIAPUBFUN unsigned nta_outgoing_delay(nta_outgoing_t const *orq);
00381 
00382 SOFIAPUBFUN url_t const *nta_outgoing_request_uri(nta_outgoing_t const *orq);
00383 SOFIAPUBFUN url_t const *nta_outgoing_route_uri(nta_outgoing_t const *orq);
00384 
00385 SOFIAPUBFUN msg_t *nta_outgoing_getresponse(nta_outgoing_t *orq);
00386 SOFIAPUBFUN msg_t *nta_outgoing_getrequest(nta_outgoing_t *orq);
00387 
00388 SOFIAPUBFUN
00389 nta_outgoing_t *nta_outgoing_tagged(nta_outgoing_t *orq, 
00390                                     nta_response_f *callback,
00391                                     nta_outgoing_magic_t *magic,
00392                                     char const *to_tag,
00393                                     sip_rseq_t const *rseq);
00394 
00395 SOFIAPUBFUN int nta_outgoing_cancel(nta_outgoing_t *);
00396 
00397 SOFIAPUBFUN
00398 nta_outgoing_t *nta_outgoing_tcancel(nta_outgoing_t *orq, 
00399                                      nta_response_f *callback,
00400                                      nta_outgoing_magic_t *magic,
00401                                      tag_type_t, tag_value_t, ...);
00402 
00403 SOFIAPUBFUN void nta_outgoing_destroy(nta_outgoing_t *);
00404 
00405 SOFIAPUBFUN
00406 nta_outgoing_t *nta_outgoing_find(nta_agent_t const *sa,
00407                                   msg_t const *msg,
00408                                   sip_t const *sip, 
00409                                   sip_via_t const *v);
00410 
00411 SOFIAPUBFUN int nta_tport_keepalive(nta_outgoing_t *orq);
00412 
00413 /* ----------------------------------------------------------------------
00414  * 8) Reliable provisional responses (100rel)
00415  */
00416 
00417 /* UAC side */
00418 
00419 SOFIAPUBFUN
00420 nta_outgoing_t *nta_outgoing_prack(nta_leg_t *leg,
00421                                    nta_outgoing_t *oorq,
00422                                    nta_response_f *callback,
00423                                    nta_outgoing_magic_t *magic,
00424                                    url_string_t const *route_url,
00425                                    sip_t const *response_to_prack,
00426                                    tag_type_t, tag_value_t, ...);
00427 
00428 SOFIAPUBFUN uint32_t nta_outgoing_rseq(nta_outgoing_t const *orq);
00429 SOFIAPUBFUN int nta_outgoing_setrseq(nta_outgoing_t *orq, uint32_t rseq);
00430 
00431 /* UAS side */
00432 
00434 typedef struct nta_reliable_s   nta_reliable_t;
00435 
00436 #ifndef NTA_RELIABLE_MAGIC_T
00437 
00440 #define NTA_RELIABLE_MAGIC_T struct nta_reliable_magic_s
00441 #endif
00442 
00444 typedef NTA_RELIABLE_MAGIC_T  nta_reliable_magic_t;
00445 
00446 typedef int nta_prack_f(nta_reliable_magic_t *rmagic,
00447                         nta_reliable_t *rel,
00448                         nta_incoming_t *prack, 
00449                         sip_t const *sip);
00450 
00451 SOFIAPUBFUN
00452 nta_reliable_t *nta_reliable_treply(nta_incoming_t *ireq,
00453                                     nta_prack_f *callback,
00454                                     nta_reliable_magic_t *rmagic,
00455                                     int status, char const *phrase, 
00456                                     tag_type_t tag, 
00457                                     tag_value_t value, ...);
00458 
00459 SOFIAPUBFUN
00460 nta_reliable_t *nta_reliable_mreply(nta_incoming_t *irq, 
00461                                     nta_prack_f *callback,
00462                                     nta_reliable_magic_t *rmagic,
00463                                     msg_t *msg);
00464 
00465 SOFIAPUBFUN void nta_reliable_destroy(nta_reliable_t *);
00466 
00467 /* ----------------------------------------------------------------------
00468  * Backward-compatibility stuff - going away soon
00469  */
00470 
00471 #define nta_outgoing_tmcreate nta_outgoing_mcreate
00472 #define nta_msg_response_complete(msg, irq, status, phrase) \
00473   nta_incoming_complete_response((irq), (msg), (status), (phrase), TAG_END())
00474 
00475 SOFIAPUBFUN void nta_msg_discard(nta_agent_t *agent, msg_t *msg);
00476 
00477 SOFIA_END_DECLS
00478 
00479 #endif

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