LLViewerExtension Class Reference

Viewer extension class Describes a Second Life viewer extension. More...

#include <llviewercommunication.h>

Collaboration diagram for LLViewerExtension:

[legend]List of all members.

Public Member Functions
	LLViewerExtension (const LLString &name="<unknown>", const U32 version=0, viewer_extension_callback_t callback=NULL, void *user_data=NULL, const LLString &author="", const LLString &description="")
	Creates a LLViewerExtension.
LLString	asString () const
LLString	getName () const
LLString	getAuthor () const
LLString	getDescription () const
U32	getVersion () const
void	notify (LLString &data, LLViewerCircuit &circuit)
	Notifies the extension that a message has arrived.
Protected Attributes
LLString	mName
LLString	mAuthor
LLString	mDescription
U32	mVersion
viewer_extension_callback_t	mCallback
void *	mUserData

---

Detailed Description

Viewer extension class Describes a Second Life viewer extension.

Definition at line 72 of file llviewercommunication.h.

---

Constructor & Destructor Documentation

LLViewerExtension::LLViewerExtension	(	const LLString &	name = "<unknown>",
		const U32	version = 0,
		viewer_extension_callback_t	callback = NULL,
		void *	user_data = NULL,
		const LLString &	author = "",
		const LLString &	description = ""
	)			[inline]

Creates a LLViewerExtension.

Parameters:

	name	Extension name
	version	Extension's version
	callback	Callback to call when a script tries to communicate with this extension
	user_data	arbitrary data to pass to the callback
	author	Extension's author
	description	Extension's description

Definition at line 84 of file llviewercommunication.h.

---

Member Function Documentation

LLString LLViewerExtension::asString

(

)

const [inline]

Definition at line 87 of file llviewercommunication.h.

References mName.

LLString LLViewerExtension::getAuthor

(

)

const [inline]

Definition at line 90 of file llviewercommunication.h.

References mAuthor.

LLString LLViewerExtension::getDescription

(

void

)

const [inline]

Definition at line 91 of file llviewercommunication.h.

References mDescription.

LLString LLViewerExtension::getName

(

void

)

const [inline]

Definition at line 89 of file llviewercommunication.h.

References mName.

Referenced by LLViewerCommunication::registerExtension().

U32 LLViewerExtension::getVersion

(

)

const [inline]

Definition at line 92 of file llviewercommunication.h.

References mVersion.

void LLViewerExtension::notify	(	LLString &	data,
		LLViewerCircuit &	circuit
	)			[inline]

Notifies the extension that a message has arrived.

Parameters:

	data	String the object sent to the extension
	circuit	Circuit between viewer and object. Used to reply to the request.

Definition at line 99 of file llviewercommunication.h.

References mCallback, and mUserData.

Referenced by LLViewerCommunication::parse().

---

Member Data Documentation

LLString LLViewerExtension::mAuthor [protected]

Definition at line 102 of file llviewercommunication.h.

Referenced by getAuthor().

viewer_extension_callback_t LLViewerExtension::mCallback [protected]

Definition at line 106 of file llviewercommunication.h.

Referenced by notify().

LLString LLViewerExtension::mDescription [protected]

Definition at line 103 of file llviewercommunication.h.

Referenced by getDescription().

LLString LLViewerExtension::mName [protected]

Definition at line 101 of file llviewercommunication.h.

Referenced by asString(), and getName().

void* LLViewerExtension::mUserData [protected]

Definition at line 107 of file llviewercommunication.h.

Referenced by notify().

U32 LLViewerExtension::mVersion [protected]

Definition at line 104 of file llviewercommunication.h.

Referenced by getVersion().

---

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

• llviewercommunication.h

---