a6b15933a6a30119f0588934280ab7cb2c1b1fb7
[WebKit-https.git] / Source / WebKit2 / Platform / IPC / Attachment.h
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef Attachment_h
27 #define Attachment_h
28
29 #if OS(DARWIN)
30 #include <mach/mach_init.h>
31 #include <mach/mach_traps.h>
32 #endif
33
34 namespace IPC {
35
36 class ArgumentDecoder;
37 class ArgumentEncoder;
38
39 class Attachment {
40 public:
41     Attachment();
42
43     enum Type {
44         Uninitialized,
45 #if OS(DARWIN)
46         MachPortType,
47 #elif USE(UNIX_DOMAIN_SOCKETS)
48         SocketType,
49         MappedMemoryType
50 #endif
51     };
52
53 #if OS(DARWIN)
54     Attachment(mach_port_name_t port, mach_msg_type_name_t disposition);
55 #elif USE(UNIX_DOMAIN_SOCKETS)
56     Attachment(Attachment&&);
57     Attachment& operator=(Attachment&&);
58     Attachment(const Attachment&) = default;
59     Attachment& operator=(Attachment&) = default;
60     Attachment(int fileDescriptor, size_t);
61     Attachment(int fileDescriptor);
62 #endif
63
64     Type type() const { return m_type; }
65
66 #if OS(DARWIN)
67     void release();
68
69     // MachPortType
70     mach_port_name_t port() const { return m_port; }
71     mach_msg_type_name_t disposition() const { return m_disposition; }
72
73 #elif USE(UNIX_DOMAIN_SOCKETS)
74     size_t size() const { return m_size; }
75
76     int releaseFileDescriptor() { int temp = m_fileDescriptor; m_fileDescriptor = -1; return temp; }
77     int fileDescriptor() const { return m_fileDescriptor; }
78
79     void dispose();
80 #endif
81
82     void encode(ArgumentEncoder&) const;
83     static bool decode(ArgumentDecoder&, Attachment&);
84     
85 private:
86     Type m_type;
87
88 #if OS(DARWIN)
89     mach_port_name_t m_port;
90     mach_msg_type_name_t m_disposition;
91 #elif USE(UNIX_DOMAIN_SOCKETS)
92     int m_fileDescriptor { -1 };
93     size_t m_size;
94 #endif
95 };
96
97 } // namespace IPC
98
99 #endif // Attachment_h