TIL_DeepSocketListener Class Reference

#include <TIL_DeepSocketListener.h>

List of all members.

Public Member Functions
	~TIL_DeepSocketListener ()
	Calls terminate().
void	setMousePosition (int x, int y)
bool	start ()
void	stop ()
void	terminate (bool kill_proc=false)
bool	isComplete () const
	Return true when the socket has been closed.
UT_Lock &	getLock ()
Static Public Member Functions
static TIL_DeepSocketListener *	create (UT_NetSocket *socket, TIL_DeepRasterReader *reader)

---

Detailed Description

Definition at line 32 of file TIL_DeepSocketListener.h.

---

Constructor & Destructor Documentation

TIL_DeepSocketListener::~TIL_DeepSocketListener

(

)

Calls terminate().

---

Member Function Documentation

static TIL_DeepSocketListener* TIL_DeepSocketListener::create	(	UT_NetSocket *	socket,
		TIL_DeepRasterReader *	reader
	)			[static]

Create an instance of TIL_DeepSocketListener. socket - the socket over which the deep raster will be sent. This instance will delete the socket when it is finished with it. reader - the deep raster reader to use. This is allocated and freed by the caller.

UT_Lock& TIL_DeepSocketListener::getLock

(

)

[inline]

Since the deep socket listener will run in a separate thread, it's necessary to lock around operations that are accessing any shared data in a thread-unsafe fashion.

Definition at line 67 of file TIL_DeepSocketListener.h.

bool TIL_DeepSocketListener::isComplete

(

)

const [inline]

Return true when the socket has been closed.

Definition at line 61 of file TIL_DeepSocketListener.h.

void TIL_DeepSocketListener::setMousePosition	(	int	x,
		int	y
	)

bool TIL_DeepSocketListener::start

(

)

Start/stop listening on the socket provided to create(). start() returns false if the socket is shut down. Successive calls to either method have no effect.

void TIL_DeepSocketListener::stop

(

)

void TIL_DeepSocketListener::terminate

(

bool

kill_proc = false

)

Stop listening (calls stop()) and kill the socket connection. Consecutive calls have no effect. Once terminated, start() and stop() have no effect.

---

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

• TIL/TIL_DeepSocketListener.h