1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.SocketControlMessage;
26 
27 private import gio.c.functions;
28 public  import gio.c.types;
29 private import gobject.ObjectG;
30 public  import gtkc.giotypes;
31 
32 
33 /**
34  * A #GSocketControlMessage is a special-purpose utility message that
35  * can be sent to or received from a #GSocket. These types of
36  * messages are often called "ancillary data".
37  * 
38  * The message can represent some sort of special instruction to or
39  * information from the socket or can represent a special kind of
40  * transfer to the peer (for example, sending a file descriptor over
41  * a UNIX socket).
42  * 
43  * These messages are sent with g_socket_send_message() and received
44  * with g_socket_receive_message().
45  * 
46  * To extend the set of control message that can be sent, subclass this
47  * class and override the get_size, get_level, get_type and serialize
48  * methods.
49  * 
50  * To extend the set of control messages that can be received, subclass
51  * this class and implement the deserialize method. Also, make sure your
52  * class is registered with the GType typesystem before calling
53  * g_socket_receive_message() to read such a message.
54  */
55 public class SocketControlMessage : ObjectG
56 {
57 	/** the main Gtk struct */
58 	protected GSocketControlMessage* gSocketControlMessage;
59 
60 	/** Get the main Gtk struct */
61 	public GSocketControlMessage* getSocketControlMessageStruct(bool transferOwnership = false)
62 	{
63 		if (transferOwnership)
64 			ownedRef = false;
65 		return gSocketControlMessage;
66 	}
67 
68 	/** the main Gtk struct as a void* */
69 	protected override void* getStruct()
70 	{
71 		return cast(void*)gSocketControlMessage;
72 	}
73 
74 	/**
75 	 * Sets our main struct and passes it to the parent class.
76 	 */
77 	public this (GSocketControlMessage* gSocketControlMessage, bool ownedRef = false)
78 	{
79 		this.gSocketControlMessage = gSocketControlMessage;
80 		super(cast(GObject*)gSocketControlMessage, ownedRef);
81 	}
82 
83 
84 	/** */
85 	public static GType getType()
86 	{
87 		return g_socket_control_message_get_type();
88 	}
89 
90 	/**
91 	 * Tries to deserialize a socket control message of a given
92 	 * @level and @type. This will ask all known (to GType) subclasses
93 	 * of #GSocketControlMessage if they can understand this kind
94 	 * of message and if so deserialize it into a #GSocketControlMessage.
95 	 *
96 	 * If there is no implementation for this kind of control message, %NULL
97 	 * will be returned.
98 	 *
99 	 * Params:
100 	 *     level = a socket level
101 	 *     type = a socket control message type for the given @level
102 	 *     data = pointer to the message data
103 	 *
104 	 * Returns: the deserialized message or %NULL
105 	 *
106 	 * Since: 2.22
107 	 */
108 	public static SocketControlMessage deserialize(int level, int type, ubyte[] data)
109 	{
110 		auto p = g_socket_control_message_deserialize(level, type, cast(size_t)data.length, data.ptr);
111 
112 		if(p is null)
113 		{
114 			return null;
115 		}
116 
117 		return ObjectG.getDObject!(SocketControlMessage)(cast(GSocketControlMessage*) p, true);
118 	}
119 
120 	/**
121 	 * Returns the "level" (i.e. the originating protocol) of the control message.
122 	 * This is often SOL_SOCKET.
123 	 *
124 	 * Returns: an integer describing the level
125 	 *
126 	 * Since: 2.22
127 	 */
128 	public int getLevel()
129 	{
130 		return g_socket_control_message_get_level(gSocketControlMessage);
131 	}
132 
133 	/**
134 	 * Returns the protocol specific type of the control message.
135 	 * For instance, for UNIX fd passing this would be SCM_RIGHTS.
136 	 *
137 	 * Returns: an integer describing the type of control message
138 	 *
139 	 * Since: 2.22
140 	 */
141 	public int getMsgType()
142 	{
143 		return g_socket_control_message_get_msg_type(gSocketControlMessage);
144 	}
145 
146 	/**
147 	 * Returns the space required for the control message, not including
148 	 * headers or alignment.
149 	 *
150 	 * Returns: The number of bytes required.
151 	 *
152 	 * Since: 2.22
153 	 */
154 	public size_t getSize()
155 	{
156 		return g_socket_control_message_get_size(gSocketControlMessage);
157 	}
158 
159 	/**
160 	 * Converts the data in the message to bytes placed in the
161 	 * message.
162 	 *
163 	 * @data is guaranteed to have enough space to fit the size
164 	 * returned by g_socket_control_message_get_size() on this
165 	 * object.
166 	 *
167 	 * Params:
168 	 *     data = A buffer to write data to
169 	 *
170 	 * Since: 2.22
171 	 */
172 	public void serialize(void* data)
173 	{
174 		g_socket_control_message_serialize(gSocketControlMessage, data);
175 	}
176 }