Inheritance diagram for LocalUser:

Public Member Functions
	LocalUser (int fd, irc::sockets::sockaddrs client, irc::sockets::sockaddrs server)

	LocalUser (int fd, const std::string &uuid, Serializable::Data &data)

CullResult	cull ()

ConnectClass *	GetClass () const

void	CheckClass (bool clone_count=true)

bool	CheckLines (bool doZline=false)

void	FullConnect ()

void	SetClass (const std::string &explicit_name="")

bool	SetClientIP (const std::string &address)

void	SetClientIP (const irc::sockets::sockaddrs &sa)

void	WriteRemoteNotice (const std::string &text)

bool	HasCommandPermission (const std::string &command)

bool	HasPrivPermission (const std::string &privstr)

bool	HasModePermission (const ModeHandler *mh) const

bool	HasSnomaskPermission (char chr) const

void	OverruleNick ()

void	Send (ClientProtocol::Event &protoev)

void	Send (ClientProtocol::EventProvider &protoevprov, ClientProtocol::Message &msg)

bool	Deserialize (Data &data)

bool	Serialize (Serializable::Data &data)

Public Member Functions inherited from User
const std::string &	GetIPString ()

const std::string &	GetHost (bool uncloak) const

const std::string &	GetBanIdent () const

const std::string &	GetDisplayedHost () const

const std::string &	GetRealHost () const

const std::string &	GetRealName () const

irc::sockets::cidr_mask	GetCIDRMask ()

	User (const std::string &uid, Server *srv, UserType objtype)

virtual const std::string &	GetFullHost ()

virtual const std::string &	GetFullRealHost ()

void	InvalidateCache ()

bool	IsAway () const

bool	IsOper () const

bool	IsNoticeMaskSet (unsigned char sm)

std::string	GetModeLetters (bool includeparams=false) const

bool	IsModeSet (unsigned char m) const

bool	IsModeSet (const ModeHandler *mh) const

bool	IsModeSet (const ModeHandler &mh) const

bool	IsModeSet (UserModeReference &moderef) const

void	SetMode (ModeHandler *mh, bool value)

void	SetMode (ModeHandler &mh, bool value)

const std::string &	MakeHost ()

const std::string &	MakeHostIP ()

void	Oper (OperInfo *info)

void	UnOper ()

void	WriteNotice (const std::string &text)

virtual void	WriteRemoteNumeric (const Numeric::Numeric &numeric)

template<typename T1 >
void	WriteRemoteNumeric (unsigned int numeric, T1 p1)

template<typename T1 , typename T2 >
void	WriteRemoteNumeric (unsigned int numeric, T1 p1, T2 p2)

template<typename T1 , typename T2 , typename T3 >
void	WriteRemoteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3)

template<typename T1 , typename T2 , typename T3 , typename T4 >
void	WriteRemoteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void	WriteRemoteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)

void	WriteNumeric (const Numeric::Numeric &numeric)

template<typename T1 >
void	WriteNumeric (unsigned int numeric, T1 p1)

template<typename T1 , typename T2 >
void	WriteNumeric (unsigned int numeric, T1 p1, T2 p2)

template<typename T1 , typename T2 , typename T3 >
void	WriteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3)

template<typename T1 , typename T2 , typename T3 , typename T4 >
void	WriteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void	WriteNumeric (unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)

void	WriteCommonRaw (ClientProtocol::Event &protoev, bool include_self=true)

already_sent_t	ForEachNeighbor (ForEachNeighborHandler &handler, bool include_self=true)

bool	SharesChannelWith (User *other)

bool	ChangeDisplayedHost (const std::string &host)

void	ChangeRealHost (const std::string &host, bool resetdisplay)

bool	ChangeIdent (const std::string &newident)

bool	ChangeRealName (const std::string &real)

bool	ChangeNick (const std::string &newnick, time_t newts=0)

void	PurgeEmptyChannels ()

virtual	~User ()

Public Member Functions inherited from Extensible
const ExtensibleStore &	GetExtList () const

void	doUnhookExtensions (const std::vector< reference< ExtensionItem > > &toRemove)

void	FreeAllExtItems ()

Public Attributes
UserIOHandler	eh

ClientProtocol::Serializer *	serializer

unsigned int	bytes_in

unsigned int	bytes_out

unsigned int	cmds_in

unsigned int	cmds_out

std::string	password

reference< ConnectClass >	MyClass

irc::sockets::sockaddrs	server_sa

unsigned int	quitting_sendq:1

unsigned int	lastping:1

unsigned int	exempt:1

time_t	nextping

time_t	idle_lastmsg

unsigned int	CommandFloodPenalty

already_sent_t	already_sent

Public Attributes inherited from User
time_t	age

time_t	signon

irc::sockets::sockaddrs	client_sa

std::string	nick

const std::string	uuid

std::string	ident

std::bitset< 64 >	snomasks

ChanList	chans

Server *	server

std::string	awaymsg

time_t	awaytime

reference< OperInfo >	oper

unsigned int	registered:3

unsigned int	quitting:1

bool	uniqueusername:1

const unsigned int	usertype:2

Additional Inherited Members
Public Types inherited from User
typedef insp::intrusive_list< Membership >	ChanList

Public Types inherited from Extensible
typedef insp::flat_map< reference< ExtensionItem >, void * >	ExtensibleStore

Member Function Documentation

◆ CheckClass()

void LocalUser::CheckClass ( bool clone_count = true )

Call this method to find the matching <connect> for a user, and to check them against it.

◆ CheckLines()

bool LocalUser::CheckLines ( bool doZline = false )

Check if the user matches a G- or K-line, and disconnect them if they do.

Parameters

doZline True if Z-lines should be checked (if IP has changed since initial connect) Returns true if the user matched a ban, false else.

◆ cull()

CullResult LocalUser::cull ( )

virtual

Called just prior to destruction via cull list.

Reimplemented from User.

◆ Deserialize()

bool LocalUser::Deserialize ( Serializable::Data & data )

virtual

Deserializes the specified Data instance into this object.

Parameters

data	The Data object to deserialize from.

Returns: True if the deserialisation succeeded; otherwise, false.

Reimplemented from User.

◆ FullConnect()

void LocalUser::FullConnect ( )

Use this method to fully connect a user. This will send the message of the day, check G/K/E-lines, etc.

◆ GetClass()

ConnectClass* LocalUser::GetClass ( ) const

inline

Get the connect class which this user belongs to.

Returns: A pointer to this user's connect class.

◆ HasCommandPermission()

bool LocalUser::HasCommandPermission ( const std::string & command )

virtual

Returns true or false for if a user can execute a privileged oper command. This is done by looking up their oper type from User::oper, then referencing this to their oper classes and checking the commands they can execute.

Parameters

command A command (should be all CAPS)

Returns: True if this user can execute the command

Reimplemented from User.

◆ HasModePermission()

bool LocalUser::HasModePermission ( const ModeHandler * mh ) const

virtual

Returns true or false if a user can set a privileged user or channel mode. This is done by looking up their oper type from User::oper, then referencing this to their oper classes, and checking the modes they can set.

Parameters

mh	Mode to check

Returns: True if the user can set or unset this mode.

Reimplemented from User.

◆ HasPrivPermission()

bool LocalUser::HasPrivPermission ( const std::string & privstr )

virtual

Returns true if a user has a given permission. This is used to check whether or not users may perform certain actions which admins may not wish to give to all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.

Parameters

privstr The priv to check, e.g. "users/override/topic". These are loaded free-form from the config file.

Returns: True if this user has the permission in question.

Reimplemented from User.

◆ HasSnomaskPermission()

bool LocalUser::HasSnomaskPermission ( char chr ) const

virtual

Determines whether this user can set the specified snomask.

Parameters

chr	The server notice mask character to look up.

Returns: True if the user can set the specified snomask; otherwise, false.

Reimplemented from User.

◆ OverruleNick()

void LocalUser::OverruleNick ( )

Change nick to uuid, unset REG_NICK and send a nickname overruled numeric. This is called when another user (either local or remote) needs the nick of this user and this user isn't registered.

◆ Send() [1/2]

void LocalUser::Send ( ClientProtocol::Event & protoev )

Send a protocol event to the user, consisting of one or more messages.

Parameters

protoev Event to send, may contain any number of messages.

◆ Send() [2/2]

void LocalUser::Send	(	ClientProtocol::EventProvider &	protoevprov,
		ClientProtocol::Message &	msg
	)

inline

Send a single message to the user.

Parameters

protoevprov	Protocol event provider.
msg	Message to send.

◆ Serialize()

bool LocalUser::Serialize ( Serializable::Data & data )

virtual

Deserializes the specified Data instance into this object.

Parameters

data	The Data object to deserialize from.

Returns: True if the deserialisation succeeded; otherwise, false.

Reimplemented from User.

◆ SetClass()

void LocalUser::SetClass ( const std::string & explicit_name = "" )

Set the connect class to which this user belongs to.

Parameters

explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking <connect> tags from the configuration file.

◆ SetClientIP()

bool LocalUser::SetClientIP ( const std::string & address )

virtual

Sets the client IP for this user

Returns: true if the conversion was successful

Reimplemented from User.

◆ WriteRemoteNotice()

void LocalUser::WriteRemoteNotice ( const std::string & text )

virtual

Send a NOTICE message from the local server to the user. The message will be sent even if the user is connected to a remote server.

Parameters

text	Text to send

Reimplemented from User.

Member Data Documentation

◆ bytes_in

unsigned int LocalUser::bytes_in

Stats counter for bytes inbound

◆ bytes_out

unsigned int LocalUser::bytes_out

Stats counter for bytes outbound

◆ cmds_in

unsigned int LocalUser::cmds_in

Stats counter for commands inbound

◆ cmds_out

unsigned int LocalUser::cmds_out

Stats counter for commands outbound

◆ CommandFloodPenalty

unsigned int LocalUser::CommandFloodPenalty

This value contains how far into the penalty threshold the user is. This is used either to enable fake lag or for excess flood quits

◆ exempt

unsigned int LocalUser::exempt

This is true if the user matched an exception (E-line). It is used to save time on ban checks.

◆ idle_lastmsg

time_t LocalUser::idle_lastmsg

Time that the connection last sent a message, used to calculate idle time

◆ lastping

unsigned int LocalUser::lastping

has the user responded to their previous ping?

◆ MyClass

reference<ConnectClass> LocalUser::MyClass

Contains a pointer to the connect class a user is on from

◆ nextping

time_t LocalUser::nextping

The time at which this user should be pinged next.

◆ password

std::string LocalUser::password

Password specified by the user when they registered (if any). This is stored even if the <connect> block doesnt need a password, so that modules may check it.

◆ quitting_sendq

unsigned int LocalUser::quitting_sendq

Recursion fix: user is out of SendQ and will be quit as soon as possible. This can't be handled normally because QuitUser itself calls Write on other users, which could trigger their SendQ to overrun.

◆ serializer

ClientProtocol::Serializer* LocalUser::serializer

Serializer to use when communicating with the user

◆ server_sa

irc::sockets::sockaddrs LocalUser::server_sa

Server address and port that this user is connected to.

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

include/users.h
include/inspircd.h
src/serializable.cpp
src/users.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ CheckClass()

◆ CheckLines()

◆ cull()

◆ Deserialize()

◆ FullConnect()

◆ GetClass()

◆ HasCommandPermission()

◆ HasModePermission()

◆ HasPrivPermission()

◆ HasSnomaskPermission()

◆ OverruleNick()

◆ Send() [1/2]

◆ Send() [2/2]

◆ Serialize()

◆ SetClass()

◆ SetClientIP()

◆ WriteRemoteNotice()

Member Data Documentation

◆ bytes_in

◆ bytes_out

◆ cmds_in

◆ cmds_out

◆ CommandFloodPenalty

◆ exempt

◆ idle_lastmsg

◆ lastping

◆ MyClass

◆ nextping

◆ password

◆ quitting_sendq

◆ serializer

◆ server_sa