blob: 908cd6bd473c14e986b6651aa10d494b332d5cb6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* Copyright 2020-2021 IGEL Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file dlmclient.h
*/
#ifndef DLM_CLIENT_H
#define DLM_CLIENT_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdbool.h>
/**
* @brief Enable debug logging
*
* @param[in] enable enable/disable debug logging
*/
void dlm_enable_debug_log(bool enable);
/**
* @brief lease handle
*/
struct dlm_lease;
/**
* @brief Get a DRM lease from the lease manager
*
* @param[in] name requested lease
* @return A pointer to a lease handle on success.
* On error this function returns NULL and errno is set accordingly.
*
* Possible errors:
*
* errno | Meaning
* -------------|-------------------------------------------------------------
* EACCESS | Cannot access lease manager socket directory
* EACCESS | Lease request denied by lease manager
* ENAMETOOLONG | The path to the lease manager socket directory is too long
* ENOENT | Lease manager or requested lease not available
* ENOMEM | Out of memory during operation
* EPROTO | Protocol error in communication with lease manager
*
* This list is not exhaustive, and errno may be set to other error codes,
* especially those related to socket communication.
*/
struct dlm_lease *dlm_get_lease(const char *name);
/**
* @brief Release a lease handle
*
* @details Release a lease handle. The lease handle will be invalidated and
* the associated DRM lease wil be revoked. Any fd's retrieved from
* dlm_lease_fd() will be closed.
* @param[in] lease pointer to lease handle
*/
void dlm_release_lease(struct dlm_lease *lease);
/**
* @brief Get a DRM Master fd from a valid lease handle
*
* @param[in] lease pointer to a lease handle
* @return A DRM Master file descriptor for the lease on success.
* -1 is returned when called with a NULL lease handle.
*/
int dlm_lease_fd(struct dlm_lease *lease);
#ifdef __cplusplus
}
#endif
#endif
|
