00001 /* ==================================================================== 00002 * The Kannel Software License, Version 1.0 00003 * 00004 * Copyright (c) 2001-2008 Kannel Group 00005 * Copyright (c) 1998-2001 WapIT Ltd. 00006 * All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions 00010 * are met: 00011 * 00012 * 1. Redistributions of source code must retain the above copyright 00013 * notice, this list of conditions and the following disclaimer. 00014 * 00015 * 2. Redistributions in binary form must reproduce the above copyright 00016 * notice, this list of conditions and the following disclaimer in 00017 * the documentation and/or other materials provided with the 00018 * distribution. 00019 * 00020 * 3. The end-user documentation included with the redistribution, 00021 * if any, must include the following acknowledgment: 00022 * "This product includes software developed by the 00023 * Kannel Group (http://www.kannel.org/)." 00024 * Alternately, this acknowledgment may appear in the software itself, 00025 * if and wherever such third-party acknowledgments normally appear. 00026 * 00027 * 4. The names "Kannel" and "Kannel Group" must not be used to 00028 * endorse or promote products derived from this software without 00029 * prior written permission. For written permission, please 00030 * contact org@kannel.org. 00031 * 00032 * 5. Products derived from this software may not be called "Kannel", 00033 * nor may "Kannel" appear in their name, without prior written 00034 * permission of the Kannel Group. 00035 * 00036 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 00037 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00038 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00039 * DISCLAIMED. IN NO EVENT SHALL THE KANNEL GROUP OR ITS CONTRIBUTORS 00040 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 00041 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 00042 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 00043 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 00044 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 00045 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 00046 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00047 * ==================================================================== 00048 * 00049 * This software consists of voluntary contributions made by many 00050 * individuals on behalf of the Kannel Group. For more information on 00051 * the Kannel Group, please see <http://www.kannel.org/>. 00052 * 00053 * Portions of this software are based upon software originally written at 00054 * WapIT Ltd., Helsinki, Finland for the Kannel project. 00055 */ 00056 00057 /* wsp_caps.h - interface to WSP capability negotiation 00058 * 00059 * Richard Braakman 00060 */ 00061 00062 #ifndef WSP_CAPS_H 00063 #define WSP_CAPS_H 00064 00065 #include "gwlib/gwlib.h" 00066 00067 struct capability { 00068 /* One or the other of these is set. id is only meaningful 00069 * if name is NULL. (Unfortunately the WSP spec does not 00070 * really assign names to the numeric ids, so we can't translate 00071 * them all to text.) */ 00072 int id; 00073 Octstr *name; 00074 00075 /* Raw data for this capability. Can be NULL if there is none. */ 00076 Octstr *data; 00077 00078 /* If data is NULL, this field determines if the request should 00079 * be accepted or rejected. */ 00080 int accept; 00081 }; 00082 00083 typedef struct capability Capability; 00084 00085 /* See table 37 */ 00086 enum known_caps { 00087 WSP_CAPS_CLIENT_SDU_SIZE = 0, 00088 WSP_CAPS_SERVER_SDU_SIZE = 1, 00089 WSP_CAPS_PROTOCOL_OPTIONS = 2, 00090 WSP_CAPS_METHOD_MOR = 3, 00091 WSP_CAPS_PUSH_MOR = 4, 00092 WSP_CAPS_EXTENDED_METHODS = 5, 00093 WSP_CAPS_HEADER_CODE_PAGES = 6, 00094 WSP_CAPS_ALIASES = 7, 00095 WSP_NUM_CAPS 00096 }; 00097 00098 /* Create a new Capability structure. For numbered capabilities (which 00099 * is all of the known ones), use NULL for the name. The data may also 00100 * be NULL. */ 00101 Capability *wsp_cap_create(int id, Octstr *name, Octstr *data); 00102 void wsp_cap_destroy(Capability *cap); 00103 00104 void wsp_cap_dump(Capability *cap); 00105 void wsp_cap_dump_list(List *caps_list); 00106 00107 /* Destroy all Capabilities in a list, as well as the list itself. */ 00108 void wsp_cap_destroy_list(List *caps_list); 00109 00110 /* Duplicate a list of Capabilities */ 00111 List *wsp_cap_duplicate_list(List *cap); 00112 Capability *wsp_cap_duplicate(Capability *cap); 00113 00114 /* Return a list of Capability structures */ 00115 List *wsp_cap_unpack_list(Octstr *caps); 00116 00117 /* Encode a list of Capability structures according to the WSP spec */ 00118 Octstr *wsp_cap_pack_list(List *caps_list); 00119 00120 /* Access functions. All of them return the number of requests that 00121 * match the capability being searched for, and if they have an output 00122 * parameter, they set it to the value of the first such request. */ 00123 int wsp_cap_count(List *caps_list, int id, Octstr *name); 00124 int wsp_cap_get_client_sdu(List *caps_list, unsigned long *sdu); 00125 int wsp_cap_get_server_sdu(List *caps_list, unsigned long *sdu); 00126 int wsp_cap_get_method_mor(List *caps_list, unsigned long *mor); 00127 int wsp_cap_get_push_mor(List *caps_list, unsigned long *mor); 00128 00129 #endif