FS_ServerSocketListener Class Reference

#include <FS_ServerSocketListener.h>

Inheritance diagram for FS_ServerSocketListener:

Public Types
typedef void(*	ChildExitedCallback )(FS_ServerSocketListener &, void *callback_data, bool listener_forced_to_close)

Public Member Functions
	~FS_ServerSocketListener () override
const char *	getClassName () const override
int	getPort () const
int	getRequestedPort () const
const UT_String &	getIPMask () const
void	closeSocketOnChildExit (pid_t child_pid, bool delete_on_child_exit=false, ChildExitedCallback child_exited_callback=0, void *callback_data=0)
bool	areEventsWaiting () override
int	processEvents () override
int	getFileDescriptor () override
int	getPollTime () override
Public Member Functions inherited from FS_EventGenerator
	FS_EventGenerator ()
virtual	~FS_EventGenerator ()
int	installGenerator ()
void	uninstallGenerator ()
void	pollEventLoop (bool drain_queue=true)

Static Public Member Functions
static FS_ServerSocketListener *	createSocketListener (int port, FS_ConnectedSocketListener::Callback callback, void *callback_data=0, const char *ip_mask=0, bool remap_privileged_ports=false)
Static Public Member Functions inherited from FS_EventGenerator
static void	setInstaller (FS_EventInstaller installer)
static void	setEventLoopPollCallback (FS_PollCallback callback)
static bool	isEventLoopPollCallbackSet ()

Protected Member Functions
	FS_ServerSocketListener (UT_NetSocket *server_socket, int requested_port, FS_ConnectedSocketListener::Callback callback, void *callback_data, const char *ip_mask)
UT_NetSocket *	getServerSocket ()
virtual void	createConnectedSocketListener ()

Detailed Description

Definition at line 24 of file FS_ServerSocketListener.h.

Member Typedef Documentation

typedef void(* FS_ServerSocketListener::ChildExitedCallback)(FS_ServerSocketListener &, void *callback_data, bool listener_forced_to_close)

Definition at line 66 of file FS_ServerSocketListener.h.

Constructor & Destructor Documentation

FS_ServerSocketListener::~FS_ServerSocketListener ( )

override

FS_ServerSocketListener::FS_ServerSocketListener ( UT_NetSocket *  server_socket, int  requested_port, FS_ConnectedSocketListener::Callback  callback, void *  callback_data, const char *  ip_mask  )

protected

Member Function Documentation

bool FS_ServerSocketListener::areEventsWaiting ( )

overridevirtual

Reimplemented from FS_EventGenerator.

void FS_ServerSocketListener::closeSocketOnChildExit	(	pid_t	child_pid,
		bool	delete_on_child_exit = false,
		ChildExitedCallback	child_exited_callback = 0,
		void *	callback_data = 0
	)

virtual void FS_ServerSocketListener::createConnectedSocketListener ( )

protectedvirtual

static FS_ServerSocketListener* FS_ServerSocketListener::createSocketListener ( int  port, FS_ConnectedSocketListener::Callback  callback, void *  callback_data = 0, const char *  ip_mask = 0, bool  remap_privileged_ports = false  )

static

const char* FS_ServerSocketListener::getClassName ( ) const

inlineoverridevirtual

Implements FS_EventGenerator.

Definition at line 43 of file FS_ServerSocketListener.h.

int FS_ServerSocketListener::getFileDescriptor ( )

overridevirtual

Reimplemented from FS_EventGenerator.

const UT_String& FS_ServerSocketListener::getIPMask ( ) const

inline

Definition at line 54 of file FS_ServerSocketListener.h.

int FS_ServerSocketListener::getPollTime ( )

overridevirtual

Reimplemented from FS_EventGenerator.

int FS_ServerSocketListener::getPort

(

)

const

int FS_ServerSocketListener::getRequestedPort ( ) const

inline

Definition at line 50 of file FS_ServerSocketListener.h.

UT_NetSocket* FS_ServerSocketListener::getServerSocket ( )

inlineprotected

Definition at line 104 of file FS_ServerSocketListener.h.

int FS_ServerSocketListener::processEvents ( )

overridevirtual

Implements FS_EventGenerator.

---

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

• FS/FS_ServerSocketListener.h