Wasabi ExpressPlay SDK for iOS  1.23.0
ShiService.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Sushi - Broadband Services
4 |
5 | $Id: ShiService.h 8071 2016-01-05 10:10:33Z nraghu $
6 | Original author: Gilles Boccon-Gibod
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2005-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _SHI_SERVICE_H_
22 #define _SHI_SERVICE_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "ShiResults.h"
28 #include "ShiTypes.h"
29 #include "ShiInterfaces.h"
30 #include "ShiAttributes.h"
31 #include "ShiData.h"
32 
33 /*----------------------------------------------------------------------
34 | types
35 +---------------------------------------------------------------------*/
39 typedef struct {
40  const char* name;
41  const char* uid;
42 } SHI_ServiceInfo;
43 
47 typedef struct {
48  const char* name;
49  const char* uid;
50  SHI_Boolean is_device_registered;
52 } SHI_ServiceUserInfo;
53 
57 typedef struct {
58  const char* name;
59  const char* uid;
60  SHI_Boolean is_valid;
61  SHI_DateTime expiration;
64  SHI_DateTime renewal_date;
65  SHI_Data* renewal_uri_template;
68 } SHI_ServiceSubscriptionInfo;
69 
70 /*----------------------------------------------------------------------
71 | interfaces
72 +---------------------------------------------------------------------*/
73 #if defined(__cplusplus)
74 extern "C" {
75 #endif
76 
85 typedef struct SHI_Service SHI_Service;
86 
97 SHI_PUBLIC_API
98 void*
99 SHI_Service_GetInterface(SHI_Service* self, SHI_InterfaceId iface_id);
100 
109 SHI_PUBLIC_API
110 SHI_Result
111 SHI_Service_Release(SHI_Service* self);
112 
120 SHI_PUBLIC_API
121 SHI_Result
122 SHI_Service_GetInfo(SHI_Service* self, SHI_ServiceInfo* info);
123 
136 SHI_PUBLIC_API
137 SHI_Result
138 SHI_Service_GetDetails(SHI_Service* self, SHI_Attribute** details);
139 
150 typedef struct SHI_ServiceUser SHI_ServiceUser;
151 
162 SHI_PUBLIC_API
163 void*
164 SHI_ServiceUser_GetInterface(SHI_ServiceUser* self, SHI_InterfaceId iface_id);
165 
174 SHI_PUBLIC_API
175 SHI_Result
176 SHI_ServiceUser_Release(SHI_ServiceUser* self);
177 
185 SHI_PUBLIC_API
186 SHI_Result
187 SHI_ServiceUser_GetInfo(SHI_ServiceUser* self, SHI_ServiceUserInfo* info);
188 
201 SHI_PUBLIC_API
202 SHI_Result
203 SHI_ServiceUser_GetDetails(SHI_ServiceUser* self, SHI_Attribute** details);
204 
215 typedef struct SHI_ServiceSubscription SHI_ServiceSubscription;
216 
227 SHI_PUBLIC_API
228 void*
229 SHI_ServiceSubscription_GetInterface(SHI_ServiceSubscription* self, SHI_InterfaceId iface_id);
230 
239 SHI_PUBLIC_API
240 SHI_Result
241 SHI_ServiceSubscription_Release(SHI_ServiceSubscription* self);
242 
250 SHI_PUBLIC_API
251 SHI_Result
252 SHI_ServiceSubscription_GetInfo(SHI_ServiceSubscription* self, SHI_ServiceSubscriptionInfo* info);
253 
266 SHI_PUBLIC_API
267 SHI_Result
268 SHI_ServiceSubscription_GetDetails(SHI_ServiceSubscription* self, SHI_Attribute** details);
269 
272 #if defined (__cplusplus)
273 }
274 #endif
275 
276 #endif /* _SHI_SERVICE_H_ */
SHI_PUBLIC_API
#define SHI_PUBLIC_API
Definition: ShiTypes.h:52
SHI_ServiceSubscriptionInfo::renewal_uri_template
SHI_Data * renewal_uri_template
Renewal URI template for renewing subscription.
Definition: ShiService.h:65
ShiResults.h
Result codes.
SHI_ServiceSubscription
struct SHI_ServiceSubscription SHI_ServiceSubscription
A SHI_ServiceSubscription object represents information about a service subscription.
Definition: ShiService.h:215
SHI_ServiceUserInfo::is_device_registered
SHI_Boolean is_device_registered
Indicates whether the device on which the code runs is registered to this user.
Definition: ShiService.h:50
SHI_ServiceSubscriptionInfo::expiration
SHI_DateTime expiration
Expiration date for the subscription (all fields will be set to 0 if the expiration date cannot be de...
Definition: ShiService.h:61
SHI_ServiceUser_GetInterface
SHI_PUBLIC_API void * SHI_ServiceUser_GetInterface(SHI_ServiceUser *self, SHI_InterfaceId iface_id)
Obtains a pointer to a SHI_ServiceUser object with a different interface.
ShiInterfaces.h
Interfaces.
SHI_ServiceUserInfo::name
const char * name
Human-readable name for the service user.
Definition: ShiService.h:48
SHI_Attribute
struct SHI_Attribute SHI_Attribute
SHI_Attribute objects represent named values that can be arranged in a tree structure.
Definition: ShiAttributes.h:110
SHI_ServiceSubscriptionInfo
Information about a service subscription.
Definition: ShiService.h:57
SHI_ServiceInfo::name
const char * name
Human-readable name for the service.
Definition: ShiService.h:40
SHI_ServiceSubscriptionInfo::renewal_date
SHI_DateTime renewal_date
Renewal date for the subscription.
Definition: ShiService.h:64
SHI_ServiceUserInfo
Information about a service user.
Definition: ShiService.h:47
SHI_ServiceUser
struct SHI_ServiceUser SHI_ServiceUser
A SHI_ServiceUser object represents information about a service user.
Definition: ShiService.h:150
SHI_ServiceUser_GetInfo
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetInfo(SHI_ServiceUser *self, SHI_ServiceUserInfo *info)
Gets basic information about this service user.
SHI_Service_GetInterface
SHI_PUBLIC_API void * SHI_Service_GetInterface(SHI_Service *self, SHI_InterfaceId iface_id)
Obtains a pointer to a SHI_Service object with a different interface.
SHI_ServiceSubscription_Release
SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_Release(SHI_ServiceSubscription *self)
Releases this service subscription object.
SHI_ServiceInfo::uid
const char * uid
Unique ID for the service.
Definition: ShiService.h:41
SHI_ServiceUser_Release
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_Release(SHI_ServiceUser *self)
Releases this service user object.
SHI_ServiceInfo
Information about a service.
Definition: ShiService.h:39
SHI_InterfaceId
SHI_UInt32 SHI_InterfaceId
Definition: ShiInterfaces.h:33
SHI_ServiceSubscriptionInfo::name
const char * name
Human-readable name for the service subscription.
Definition: ShiService.h:58
SHI_Boolean
SHI_Boolean
Boolean type used for variables that can be true (SHI_TRUE) or false (SHI_FALSE). ...
Definition: ShiTypes.h:62
SHI_Service
struct SHI_Service SHI_Service
A SHI_Service object represents information about a service.
Definition: ShiService.h:85
SHI_Service_Release
SHI_PUBLIC_API SHI_Result SHI_Service_Release(SHI_Service *self)
Releases this service object.
SHI_DateTime
A date and time.
Definition: ShiTypes.h:128
SHI_ServiceSubscription_GetDetails
SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_GetDetails(SHI_ServiceSubscription *self, SHI_Attribute **details)
Gets the details of this service subscription.
SHI_ServiceUser_GetDetails
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetDetails(SHI_ServiceUser *self, SHI_Attribute **details)
Gets the details of this service user.
SHI_ServiceUserInfo::uid
const char * uid
Unique ID for the service user.
Definition: ShiService.h:49
SHI_ServiceSubscription_GetInfo
SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_GetInfo(SHI_ServiceSubscription *self, SHI_ServiceSubscriptionInfo *info)
Gets basic information about this service subscription.
SHI_Data
struct SHI_Data SHI_Data
A SHI_Data object represents a typed data object.
Definition: ShiData.h:116
ShiTypes.h
Common data types.
ShiAttributes.h
Attributes.
SHI_ServiceSubscription_GetInterface
SHI_PUBLIC_API void * SHI_ServiceSubscription_GetInterface(SHI_ServiceSubscription *self, SHI_InterfaceId iface_id)
Obtains a pointer to a SHI_ServiceSubscription object with a different interface. ...
SHI_Result
int SHI_Result
Signed integer value representing a function or method result (return value).
Definition: ShiTypes.h:74
SHI_Service_GetInfo
SHI_PUBLIC_API SHI_Result SHI_Service_GetInfo(SHI_Service *self, SHI_ServiceInfo *info)
Gets basic information about this service.
SHI_ServiceSubscriptionInfo::uid
const char * uid
Unique ID for the service subscription.
Definition: ShiService.h:59
SHI_Service_GetDetails
SHI_PUBLIC_API SHI_Result SHI_Service_GetDetails(SHI_Service *self, SHI_Attribute **details)
Gets the details of this service.
SHI_ServiceSubscriptionInfo::is_valid
SHI_Boolean is_valid
Indicates if the subscription is currently valid.
Definition: ShiService.h:60
ShiData.h
Generic Data Objects.