struct msghdr with a known type, fixed-size I/O and control buffers More...

#include <TypedMsgHdr.h>

Inheritance diagram for Ipc::TypedMsgHdr:

Collaboration diagram for Ipc::TypedMsgHdr:

Classes
struct	CtrlBuffer

struct	DataBuffer

Public Types
enum	{ maxSize = 4096 }

Public Member Functions
	TypedMsgHdr ()

	TypedMsgHdr (const TypedMsgHdr &tmh)

TypedMsgHdr &	operator= (const TypedMsgHdr &tmh)

void	address (const struct sockaddr_un &addr)
	sets [dest.] address More...

void	setType (int aType)
	sets message type; use MessageType enum More...

void	checkType (int aType) const

int	rawType () const

template<class Pod >
void	getPod (Pod &pod) const
	load POD More...

template<class Pod >
void	putPod (const Pod &pod)
	store POD More...

void	getString (String &s) const
	load variable-length string More...

void	putString (const String &s)
	store variable-length string More...

int	getInt () const
	load an integer More...

void	putInt (int n)
	store an integer More...

void	getFixed (void *raw, size_t size) const
	always load size bytes More...

void	putFixed (const void *raw, size_t size)
	always store size bytes More...

bool	hasMoreData () const
	returns true if there is data to extract; handy for optional parts More...

void	putFd (int aFd)
	stores descriptor More...

int	getFd () const
	returns stored descriptor More...

bool	hasFd () const
	whether the message has a descriptor stored More...

void	prepForReading ()
	reset and provide all buffers More...

char *	raw ()

const char *	raw () const

Public Attributes
void *	msg_name

socklen_t	msg_namelen

struct iovec *	msg_iov

size_t	msg_iovlen

void *	msg_control

size_t	msg_controllen

int	msg_flags

Private Member Functions
void	clear ()

void	sync ()

void	allocData ()
	initialize io vector with one io record More...

void	allocName ()

void	allocControl ()

void	getRaw (void *raw, size_t size) const
	low-level loading of exactly size bytes of raw data More...

void	putRaw (const void *raw, size_t size)
	low-level storage of exactly size bytes of raw data More...

Private Attributes
struct sockaddr_un	name
	same as .msg_name More...

struct iovec	ios [1]
	same as .msg_iov[] More...

struct Ipc::TypedMsgHdr::DataBuffer	data
	same as .msg_iov[0].iov_base More...

struct Ipc::TypedMsgHdr::CtrlBuffer	ctrl
	same as .msg_control More...

unsigned int	offset = 0
	data offset for the next get/put*() to start with More...

Detailed Description

Definition at line 34 of file TypedMsgHdr.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
maxSize

Definition at line 37 of file TypedMsgHdr.h.

Constructor & Destructor Documentation

◆ TypedMsgHdr() [1/2]

Ipc::TypedMsgHdr::TypedMsgHdr ( )

Definition at line 19 of file TypedMsgHdr.cc.

References clear(), and sync().

◆ TypedMsgHdr() [2/2]

Ipc::TypedMsgHdr::TypedMsgHdr ( const TypedMsgHdr & tmh )

Definition at line 25 of file TypedMsgHdr.cc.

Member Function Documentation

◆ address()

void Ipc::TypedMsgHdr::address ( const struct sockaddr_un & addr )

Definition at line 85 of file TypedMsgHdr.cc.

References SUN_LEN.

Referenced by Ipc::UdsSender::UdsSender().

◆ allocControl()

void Ipc::TypedMsgHdr::allocControl ( )

private

Definition at line 266 of file TypedMsgHdr.cc.

References Must.

◆ allocData()

void Ipc::TypedMsgHdr::allocData ( )

private

Definition at line 246 of file TypedMsgHdr.cc.

References Must.

◆ allocName()

void Ipc::TypedMsgHdr::allocName ( )

private

Definition at line 258 of file TypedMsgHdr.cc.

References Must.

◆ checkType()

void Ipc::TypedMsgHdr::checkType ( int aType ) const

throws if stored type is not aType

Definition at line 94 of file TypedMsgHdr.cc.

References Must.

Referenced by Mgr::Request::Request(), Snmp::Request::Request(), Snmp::Response::Response(), Mgr::Response::Response(), Ipc::SharedListenRequest::SharedListenRequest(), Ipc::SharedListenResponse::SharedListenResponse(), Ipc::StrandSearchRequest::StrandSearchRequest(), SBufStatsAction::unpack(), Mgr::StoreIoAction::unpack(), Mgr::IoAction::unpack(), Mgr::ServiceTimesAction::unpack(), DiskdAction::unpack(), Mgr::CountersAction::unpack(), Mgr::InfoAction::unpack(), and Mgr::IntervalAction::unpack().

◆ clear()

void Ipc::TypedMsgHdr::clear ( )

private

Definition at line 46 of file TypedMsgHdr.cc.

Referenced by TypedMsgHdr().

◆ getFd()

int Ipc::TypedMsgHdr::getFd ( ) const

Definition at line 217 of file TypedMsgHdr.cc.

References CMSG_FIRSTHDR, cmsghdr::cmsg_level, cmsghdr::cmsg_type, Must, SCM_RIGHTS, and SQUID_CMSG_DATA.

Referenced by Mgr::Request::Request(), Snmp::Request::Request(), and Ipc::SharedListenResponse::SharedListenResponse().

◆ getFixed()

void Ipc::TypedMsgHdr::getFixed	(	void *	raw,
		size_t	size
	)		const

Definition at line 151 of file TypedMsgHdr.cc.

Referenced by getPod(), Snmp::Session::unpack(), Snmp::Pdu::unpack(), and Snmp::Var::unpack().

◆ getInt()

int Ipc::TypedMsgHdr::getInt ( ) const

Definition at line 111 of file TypedMsgHdr.cc.

Referenced by CollapsedForwarding::HandleNotification(), IpcIoFile::HandleNotification(), Snmp::Session::unpack(), Snmp::Pdu::unpack(), Mgr::QueryParams::unpack(), Snmp::Var::unpack(), and Mgr::IntParam::unpackValue().

◆ getPod()

template<class Pod >

void Ipc::TypedMsgHdr::getPod ( Pod & pod ) const

◆ getRaw()

void Ipc::TypedMsgHdr::getRaw	(	void *	raw,
		size_t	size
	)		const

private

Definition at line 166 of file TypedMsgHdr.cc.

References Must.

◆ getString()

void Ipc::TypedMsgHdr::getString ( String & s ) const

Definition at line 125 of file TypedMsgHdr.cc.

References String::assign(), String::clean(), and Must.

Referenced by Mgr::ActionParams::ActionParams(), Mgr::Response::Response(), Ipc::StrandSearchRequest::StrandSearchRequest(), Ipc::StrandCoord::unpack(), Mgr::QueryParams::unpack(), and Mgr::StringParam::unpackValue().

◆ hasFd()

bool Ipc::TypedMsgHdr::hasFd ( ) const

Definition at line 187 of file TypedMsgHdr.cc.

References CMSG_FIRSTHDR, cmsghdr::cmsg_level, cmsghdr::cmsg_type, and SCM_RIGHTS.

Referenced by Snmp::Request::Request().

◆ hasMoreData()

bool Ipc::TypedMsgHdr::hasMoreData ( ) const

inline

Definition at line 66 of file TypedMsgHdr.h.

References data, offset, and Ipc::TypedMsgHdr::DataBuffer::size.

Referenced by Mgr::Response::Response().

◆ operator=()

Ipc::TypedMsgHdr & Ipc::TypedMsgHdr::operator= ( const TypedMsgHdr & tmh )

Definition at line 31 of file TypedMsgHdr.cc.

References ctrl, data, ios, name, and offset.

◆ prepForReading()

void Ipc::TypedMsgHdr::prepForReading ( )

Definition at line 234 of file TypedMsgHdr.cc.

◆ putFd()

void Ipc::TypedMsgHdr::putFd ( int aFd )

Definition at line 196 of file TypedMsgHdr.cc.

References CMSG_FIRSTHDR, cmsghdr::cmsg_len, CMSG_LEN, cmsghdr::cmsg_level, cmsghdr::cmsg_type, Must, SCM_RIGHTS, and SQUID_CMSG_DATA.

Referenced by Mgr::Request::pack(), Snmp::Request::pack(), and Ipc::SharedListenResponse::pack().

◆ putFixed()

void Ipc::TypedMsgHdr::putFixed	(	const void *	raw,
		size_t	size
	)

Definition at line 158 of file TypedMsgHdr.cc.

Referenced by Snmp::Session::pack(), Snmp::Pdu::pack(), and Snmp::Var::pack().

◆ putInt()

void Ipc::TypedMsgHdr::putInt ( int n )

Definition at line 119 of file TypedMsgHdr.cc.

Referenced by CollapsedForwarding::Notify(), IpcIoFile::Notify(), Mgr::IntParam::pack(), Snmp::Session::pack(), Snmp::Pdu::pack(), Mgr::QueryParams::pack(), and Snmp::Var::pack().

◆ putPod()

template<class Pod >

void Ipc::TypedMsgHdr::putPod ( const Pod & pod )

◆ putRaw()

void Ipc::TypedMsgHdr::putRaw	(	const void *	raw,
		size_t	size
	)

private

Definition at line 177 of file TypedMsgHdr.cc.

References Must.

◆ putString()

void Ipc::TypedMsgHdr::putString ( const String & s )

Definition at line 143 of file TypedMsgHdr.cc.

References Must, String::psize(), and String::rawBuf().

Referenced by Ipc::StrandSearchRequest::pack(), Ipc::StrandCoord::pack(), Mgr::StringParam::pack(), Mgr::ActionParams::pack(), Mgr::Response::pack(), and Mgr::QueryParams::pack().

◆ raw() [1/2]

char* Ipc::TypedMsgHdr::raw ( )

inline

Definition at line 75 of file TypedMsgHdr.h.

◆ raw() [2/2]

const char* Ipc::TypedMsgHdr::raw ( ) const

inline

Definition at line 76 of file TypedMsgHdr.h.

◆ rawType()

int Ipc::TypedMsgHdr::rawType ( ) const

inline

received or set message kind; may not be a MessageType value

Returns: 0 if no message kind has been received or set

Definition at line 51 of file TypedMsgHdr.h.

Referenced by Ipc::Strand::receive(), Ipc::Port::receive(), Ipc::Coordinator::receive(), and Ipc::Port::receiveOrIgnore().

◆ setType()

void Ipc::TypedMsgHdr::setType ( int aType )

◆ sync()

void Ipc::TypedMsgHdr::sync ( )

private

Definition at line 58 of file TypedMsgHdr.cc.

References Must.

Referenced by TypedMsgHdr().

Member Data Documentation

◆ ctrl

struct Ipc::TypedMsgHdr::CtrlBuffer Ipc::TypedMsgHdr::ctrl

private

Referenced by operator=().

◆ data

struct Ipc::TypedMsgHdr::DataBuffer Ipc::TypedMsgHdr::data

private

Referenced by hasMoreData(), and operator=().

◆ ios

struct iovec Ipc::TypedMsgHdr::ios[1]

private

Definition at line 93 of file TypedMsgHdr.h.

Referenced by operator=().

◆ msg_control

void* msghdr::msg_control

inherited

Definition at line 95 of file cmsg.h.

◆ msg_controllen

size_t msghdr::msg_controllen

inherited

Definition at line 96 of file cmsg.h.

◆ msg_flags

int msghdr::msg_flags

inherited

Definition at line 101 of file cmsg.h.

◆ msg_iov

struct iovec* msghdr::msg_iov

inherited

Definition at line 92 of file cmsg.h.

◆ msg_iovlen

size_t msghdr::msg_iovlen

inherited

Definition at line 93 of file cmsg.h.

◆ msg_name

void* msghdr::msg_name

inherited

Definition at line 89 of file cmsg.h.

◆ msg_namelen

socklen_t msghdr::msg_namelen

inherited

Definition at line 90 of file cmsg.h.

◆ name

struct sockaddr_un Ipc::TypedMsgHdr::name

private

Definition at line 91 of file TypedMsgHdr.h.

Referenced by operator=().

◆ offset

unsigned int Ipc::TypedMsgHdr::offset = 0

mutableprivate

Definition at line 111 of file TypedMsgHdr.h.

Referenced by hasMoreData(), and operator=().

The documentation for this class was generated from the following files:

src/ipc/TypedMsgHdr.h
src/ipc/TypedMsgHdr.cc

squid-cache.org

Optimising Web Delivery

Classes

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TypedMsgHdr() [1/2]

◆ TypedMsgHdr() [2/2]

Member Function Documentation

◆ address()

◆ allocControl()

◆ allocData()

◆ allocName()

◆ checkType()

◆ clear()

◆ getFd()

◆ getFixed()

◆ getInt()

◆ getPod()

◆ getRaw()

◆ getString()

◆ hasFd()

◆ hasMoreData()

◆ operator=()

◆ prepForReading()

◆ putFd()

◆ putFixed()

◆ putInt()

◆ putPod()

◆ putRaw()

◆ putString()

◆ raw() [1/2]

◆ raw() [2/2]

◆ rawType()

◆ setType()

◆ sync()

Member Data Documentation

◆ ctrl

◆ data

◆ ios

◆ msg_control

◆ msg_controllen

◆ msg_flags

◆ msg_iov

◆ msg_iovlen

◆ msg_name

◆ msg_namelen

◆ name

◆ offset

Introduction

Documentation

Support

Miscellaneous