MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
mh5cookies.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2010 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 #ifndef _MH5COOKIES_H
26 #define _MH5COOKIES_H
27 
28 
29 
30 /*---includes for this file--------------------------------------------------*/
31 #include "mh5base.h"
32 
33 /*---Constant and macro definitions for public use---------------------------*/
34 
35 /*---Enumerations for public use---------------------------------------------*/
36 
37 /*---Global type defs for public use-----------------------------------------*/
38 typedef struct
39 {
40  MHEG5String identity;
41  MHEG5String value;
42  MHEG5Int expires;
43  MHEG5Bool secure;
45 /*---Global variable declarations for public use-----------------------------*/
46 
47 /*---Global Function prototypes for public use-------------------------------*/
48 
56 void MHEG5CookieParse(void *data, U32BIT data_len, char *url);
57 
67 U8BIT* MHEG5CookieGenerateHeader(U8BIT *url);
68 
76 MHEG5Bool MHEG5CookieAdd(MHEG5cookie_t *cookie);
77 
86 MHEG5Bool MHEG5CookieRetrieve(MHEG5cookie_t *cookie);
87 
92 void MHEG5CookieClearStore(void);
93 
100 void MHEG5CookieAckHeader(U8BIT *header);
101 
102 
103 #endif
Basis MHEG5 data types.
Definition: mh5base.h:82
void MHEG5CookieAckHeader(U8BIT *header)
This function should be called once the header string returned by MHEG5CookieGenerateHeader has been ...
Definition: mh5cookies.c:354
MHEG5Bool MHEG5CookieRetrieve(MHEG5cookie_t *cookie)
Retrieve a specific cookie from the store, referenced by the identity string.
Definition: mh5cookies.c:368
void MHEG5CookieParse(void *data, U32BIT data_len, char *url)
Parse a Set-cookie header and add the new cookie to the store. If the header is not a set-cookie...
Definition: mh5cookies.c:102
MHEG5Bool MHEG5CookieAdd(MHEG5cookie_t *cookie)
Directly add a cookie to the store.
Definition: mh5cookies.c:317
Definition: mh5cookies.h:38
U8BIT * MHEG5CookieGenerateHeader(U8BIT *url)
Generate a "Cookie" header for the required http request, containing all valid cookies.
Definition: mh5cookies.c:243
void MHEG5CookieClearStore(void)
Delete all cookies from the temporary store.
Definition: mh5cookies.c:405