]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/ipc/TypedMsgHdr.h
2 * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 54 Interprocess Communication */
11 #ifndef SQUID_IPC_TYPED_MSG_HDR_H
12 #define SQUID_IPC_TYPED_MSG_HDR_H
14 #include "compat/cmsg.h"
16 #include <sys/socket.h>
30 /// struct msghdr with a known type, fixed-size I/O and control buffers
31 class TypedMsgHdr
: public msghdr
34 enum {maxSize
= 4096};
38 TypedMsgHdr(const TypedMsgHdr
&tmh
);
39 TypedMsgHdr
&operator =(const TypedMsgHdr
&tmh
);
41 void address(const struct sockaddr_un
&addr
); ///< sets [dest.] address
43 /* message type manipulation; these must be called before put/get*() */
44 void setType(int aType
); ///< sets message type; use MessageType enum
45 void checkType(int aType
) const; ///< throws if stored type is not aType
46 int type() const; ///< returns stored type or zero if none
48 /* access for Plain Old Data (POD)-based message parts */
50 void getPod(Pod
&pod
) const { getFixed(&pod
, sizeof(pod
)); } ///< load POD
52 void putPod(const Pod
&pod
) { putFixed(&pod
, sizeof(pod
)); } ///< store POD
54 /* access to message parts for selected commonly-used part types */
55 void getString(String
&s
) const; ///< load variable-length string
56 void putString(const String
&s
); ///< store variable-length string
57 int getInt() const; ///< load an integer
58 void putInt(int n
); ///< store an integer
59 void getFixed(void *raw
, size_t size
) const; ///< always load size bytes
60 void putFixed(const void *raw
, size_t size
); ///< always store size bytes
62 /// returns true if there is data to extract; handy for optional parts
63 bool hasMoreData() const { return offset
< data
.size
; }
65 /* access to a "file" descriptor that can be passed between processes */
66 void putFd(int aFd
); ///< stores descriptor
67 int getFd() const; ///< returns stored descriptor
68 bool hasFd() const; ///< whether the message has a descriptor stored
70 /* raw, type-independent access for I/O */
71 void prepForReading(); ///< reset and provide all buffers
72 char *raw() { return reinterpret_cast<char*>(this); }
73 const char *raw() const { return reinterpret_cast<const char*>(this); }
74 size_t size() const { return sizeof(*this); } ///< not true message size
82 /* raw, type-independent manipulation used by type-specific methods */
83 void getRaw(void *raw
, size_t size
) const;
84 void putRaw(const void *raw
, size_t size
);
87 struct sockaddr_un name
; ///< same as .msg_name
89 struct iovec ios
[1]; ///< same as .msg_iov[]
92 int type_
; ///< Message kind, uses MessageType values
93 size_t size
; ///< actual raw data size (for sanity checks)
94 char raw
[maxSize
]; ///< buffer with type-specific data
95 } data
; ///< same as .msg_iov[0].iov_base
98 /// control buffer space for one fd
99 char raw
[SQUID_CMSG_SPACE(sizeof(int))];
100 } ctrl
; ///< same as .msg_control
102 /// data offset for the next get/put*() to start with
103 mutable unsigned int offset
;
108 #endif /* SQUID_IPC_TYPED_MSG_HDR_H */