#include <xline.h>

Inheritance diagram for XLineFactory:

Public Member Functions
	XLineFactory (const std::string &t)

virtual const std::string &	GetType ()

virtual XLine *	Generate (time_t set_time, unsigned long duration, const std::string &source, const std::string &reason, const std::string &xline_specific_mask)=0

virtual bool	AutoApplyToUserList (XLine *x)

virtual	~XLineFactory ()

Protected Attributes
std::string	type

Detailed Description

XLineFactory is used to generate an XLine pointer, given just the pattern, timing information and type of line to create. This is used for example in the spanningtree module which will call an XLineFactory to create a new XLine when it is inbound on a server link, so that it does not have to know the specifics of the internals of an XLine class and/or how to call its constructor.

Constructor & Destructor Documentation

◆ XLineFactory()

XLineFactory::XLineFactory ( const std::string & t )

inline

Create an XLine factory

Parameters

t	Type of XLine this factory generates

◆ ~XLineFactory()

virtual XLineFactory::~XLineFactory ( )

inlinevirtual

Destructor

Member Function Documentation

◆ Generate()

virtual XLine* XLineFactory::Generate	(	time_t	set_time,
		unsigned long	duration,
		const std::string &	source,
		const std::string &	reason,
		const std::string &	xline_specific_mask
	)

pure virtual

Generate a specialized XLine*.

Parameters

set_time	Time this line was created
duration	Duration of the line
source	The sender of the line, nickname or server
reason	The reason for the line
xline_specific_mask	The mask string for the line, specific to the XLine type being created.

Returns: A specialized XLine class of the given type for this factory.

Implemented in ZLineFactory, QLineFactory, KLineFactory, ELineFactory, and GLineFactory.

◆ GetType()

virtual const std::string& XLineFactory::GetType ( )

inlinevirtual

Return the type of XLine this factory generates

Returns: The type of XLine this factory generates

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

include/xline.h

Public Member Functions