_icp_common_t Struct Reference
[ICP]

#include <ICP.h>

Collaboration diagram for _icp_common_t:

[legend]

List of all members.

Public Member Functions
	_icp_common_t ()
	_icp_common_t (char *buf, unsigned int len)
void	handleReply (char *buf, Ip::Address &from)
icp_opcode	getOpCode () const
Static Public Member Functions
static _icp_common_t *	createMessage (icp_opcode opcode, int flags, const char *url, int reqnum, int pad)
Public Attributes
unsigned char	opcode
unsigned char	version
unsigned short	length
u_int32_t	reqnum
u_int32_t	flags
u_int32_t	pad
u_int32_t	shostid

---

Detailed Description

This struct is the wire-level header. DO NOT add more move fields on pain of breakage. DO NOT add virtual methods.

Definition at line 50 of file ICP.h.

---

Constructor & Destructor Documentation

_icp_common_t::_icp_common_t

(

)

Todo:

I don't believe this header is included in non-c++ code anywhere the struct should become a public POD class and kill these ifdef.

Definition at line 101 of file icp_v2.cc.

References version.

_icp_common_t::_icp_common_t	(	char *	buf,
		unsigned int	len
	)

Definition at line 104 of file icp_v2.cc.

References flags, length, pad, and reqnum.

---

Member Function Documentation

_icp_common_t * _icp_common_t::createMessage	(	icp_opcode	opcode,
		int	flags,
		const char *	url,
		int	reqnum,
		int	pad
	)			[static]

Definition at line 254 of file icp_v2.cc.

References flags, ICP_QUERY, ICP_VERSION_CURRENT, length, NULL, opcode, pad, reqnum, shostid, theOutICPAddr, version, and xcalloc.

Referenced by icpCreateAndSend(), neighborsUdpPing(), and peerCountMcastPeersStart().

icp_opcode _icp_common_t::getOpCode

(

)

const

Definition at line 123 of file icp_v2.cc.

References ICP_END, ICP_INVALID, and opcode.

Referenced by peerHandleIcpReply().

void _icp_common_t::handleReply	(	char *	buf,
		Ip::Address &	from
	)

Definition at line 525 of file icp_v2.cc.

References debugs, icp_opcode_str, icpGetCacheKey(), neighbors_do_private_keys, neighborsUdpAck(), opcode, and reqnum.

Referenced by icpHandleIcpV2(), and icpHandleIcpV3().

---

Member Data Documentation

u_int32_t _icp_common_t::flags

Definition at line 59 of file ICP.h.

Referenced by _icp_common_t(), createMessage(), doV2Query(), neighbors_init(), and peerIcpParentMiss().

unsigned short _icp_common_t::length

total length (bytes)

Definition at line 56 of file ICP.h.

Referenced by _icp_common_t(), createMessage(), icpHandleIcpV2(), icpHandleIcpV3(), icpUdpSend(), and neighbors_init().

unsigned char _icp_common_t::opcode

opcode

Definition at line 52 of file ICP.h.

Referenced by ICP3State::created(), ICP2State::created(), createMessage(), getOpCode(), handleReply(), icpCount(), icpHandleIcpV2(), icpHandleIcpV3(), icpUdpSend(), neighborAlive(), neighbors_init(), and neighborsUdpAck().

u_int32_t _icp_common_t::pad

Definition at line 60 of file ICP.h.

Referenced by _icp_common_t(), createMessage(), neighbors_init(), and peerIcpParentMiss().

u_int32_t _icp_common_t::reqnum

req number (req'd for UDP)

Definition at line 58 of file ICP.h.

Referenced by _icp_common_t(), ICP3State::created(), ICP2State::created(), createMessage(), doV2Query(), doV3Query(), handleReply(), neighbors_init(), and neighborsUdpPing().

u_int32_t _icp_common_t::shostid

sender host id

Definition at line 62 of file ICP.h.

Referenced by createMessage(), and neighbors_init().

unsigned char _icp_common_t::version

version number

Definition at line 54 of file ICP.h.

Referenced by createMessage(), neighborAlive(), and neighbors_init().

---

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

• src/ICP.h
• src/icp_v2.cc