Doc: fix invalid usage of doxygen @param command
[platform/upstream/dbus.git] / dbus / dbus-pipe-unix.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-pipe-unix.c unix related pipe implementation
3  * 
4  * Copyright (C) 2002, 2003, 2006  Red Hat, Inc.
5  * Copyright (C) 2003 CodeFactory AB
6  *
7  * Licensed under the Academic Free License version 2.1
8  * 
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  * 
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24
25 #include <config.h>
26 #include "dbus-protocol.h"
27 #include "dbus-string.h"
28 #include "dbus-internals.h"
29 #include "dbus-pipe.h"
30 #include "dbus-sysdeps-unix.h"
31
32 #include <errno.h>
33
34 /**
35  * write data to a pipe.
36  *
37  * @param pipe the pipe instance
38  * @param buffer the buffer to write data from
39  * @param start the first byte in the buffer to write
40  * @param len the number of bytes to try to write
41  * @param error error return
42  * @returns the number of bytes written or -1 on error
43  */
44 int
45 _dbus_pipe_write (DBusPipe         *pipe,
46                   const DBusString *buffer,
47                   int               start,
48                   int               len,
49                   DBusError        *error)
50 {
51   int written;
52   
53   written = _dbus_write (pipe->fd, buffer, start, len);
54   if (written < 0)
55     {
56       dbus_set_error (error, DBUS_ERROR_FAILED,
57                       "Writing to pipe: %s\n",
58                       _dbus_strerror (errno));
59     }
60   return written;
61 }
62
63 /**
64  * close a pipe.
65  *
66  * @param pipe the pipe instance
67  * @param error return location for an error
68  * @returns -1 if error is set
69  */
70 int
71 _dbus_pipe_close  (DBusPipe         *pipe,
72                    DBusError        *error)
73 {
74   if (!_dbus_close (pipe->fd, error))
75     {
76       return -1;
77     }
78   else
79     {
80       _dbus_pipe_invalidate (pipe);
81       return 0;
82     }
83 }