blob: cb1bda4db7de4a876629f461e0c3cc021bc1f0b1 [file] [log] [blame]
Andrew Jeffery45cfc382017-04-12 14:15:50 +09301/*
2 * Mailbox Daemon Temporary File helpers
3 *
4 * Copyright 2017 IBM
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 */
19
20#ifndef MBOX_TEST_UTILS_H
21#define MBOX_TEST_UTILS_H
22
23#include <linux/limits.h>
24
25struct tmpf {
26 int fd;
27 char path[PATH_MAX];
28};
29
Andrew Jefferyc3144042018-02-26 13:24:52 +103030/**
31 * Initialise a tmpf instance for use, creating a temporary file.
32 *
33 * @tmpf: A context to initialise with the provided template
34 * @template_str: A file basename in mkstemp(3) template form
35 *
36 * Returns 0 on success, or -1 on error with errno set appropriately
37 */
Ratan Gupta90b92fe2017-05-05 17:34:00 +053038int tmpf_init(struct tmpf *tmpf, const char *template_str);
Andrew Jeffery45cfc382017-04-12 14:15:50 +093039
Andrew Jefferyc3144042018-02-26 13:24:52 +103040/**
41 * Destroy a tmpf instance, closing the file descriptor and removing the
42 * temporary file.
43 */
Andrew Jeffery45cfc382017-04-12 14:15:50 +093044void tmpf_destroy(struct tmpf *tmpf);
45
46#endif /* MBOX_TEST_UTILS_H */