FTS message class
[FTS System Classes]

---

Detailed Description

The FTS message class.

This is an internal class so far the host environment represents messages natively. A message object can be created empty or with a symbol as the first argument.

fts_message_t *mess = (fts_message_t *)fts_object_create(fts_message_class, NULL, ac, at);

Typedefs
typedef struct fts_message	fts_message_t
	FTS message class.
Functions
fts_symbol_t	fts_message_get_selector (fts_message_t *m)
	Get the message selector.
fts_array_t *	fts_message_get_args (fts_message_t *m)
	Get the message arguments.
int	fts_message_get_ac (fts_message_t *m)
	Get the message argument count.
fts_atom_t *	fts_message_get_at (fts_message_t *m)
	Get the message argumens as atoms array.
FTS_API void	fts_message_clear (fts_message_t *mess)
	Clear message (reset selector and arguments).
FTS_API void	fts_message_set (fts_message_t *mess, fts_symbol_t s, int ac, const fts_atom_t *at)
	Set message selector and arguments.
FTS_API void	fts_message_set_from_atoms (fts_message_t *mess, int ac, const fts_atom_t *at)
	Set message from an array.
FTS_API void	fts_message_append (fts_message_t *mess, int ac, fts_atom_t *at)
	Append arguments to a message.
FTS_API void	fts_message_append_int (fts_message_t *mess, int val)
	Append int argument to a message.
FTS_API void	fts_message_append_float (fts_message_t *mess, float val)
	Append float argument to a message.
FTS_API void	fts_message_append_symbol (fts_message_t *mess, fts_symbol_t val)
	Append symbol argument to a message.
FTS_API void	fts_message_append_object (fts_message_t *mess, fts_object_t *val)
	Append object argument to a message.
FTS_API int	fts_is_message (fts_atom_t *a)
	Check whether value is a message object.
Variables
FTS_API fts_class_t *	fts_message_class
	The FTS message class identifier.

---

Function Documentation

FTS_API int fts_is_message

(

fts_atom_t *

a

)

Check whether value is a message object.

Parameters:

a

the atom

Returns:

1 if true, 0 if false

FTS_API void fts_message_append	(	fts_message_t *	mess,
		int	ac,
		fts_atom_t *	at
	)

Append arguments to a message.

Parameters:

	mess	the message
	ac	argument count
	at	argument values

FTS_API void fts_message_append_float	(	fts_message_t *	mess,
		float	val
	)

Append float argument to a message.

Parameters:

	mess	the message
	val	float argument

FTS_API void fts_message_append_int	(	fts_message_t *	mess,
		int	val
	)

Append int argument to a message.

Parameters:

	mess	the message
	val	int argument

FTS_API void fts_message_append_object	(	fts_message_t *	mess,
		fts_object_t *	val
	)

Append object argument to a message.

Parameters:

	mess	the message
	val	fts_object argument

FTS_API void fts_message_append_symbol	(	fts_message_t *	mess,
		fts_symbol_t	val
	)

Append symbol argument to a message.

Parameters:

	mess	the message
	val	symbol argument

FTS_API void fts_message_clear

(

fts_message_t *

mess

)

Clear message (reset selector and arguments).

Parameters:

mess

the message

int fts_message_get_ac

(

fts_message_t *

m

)

Get the message argument count.

Parameters:

m

fts message

Returns:

arguments count

fts_array_t* fts_message_get_args

(

fts_message_t *

m

)

Get the message arguments.

Parameters:

m

fts message

Returns:

message args

fts_atom_t* fts_message_get_at

(

fts_message_t *

m

)

Get the message argumens as atoms array.

Parameters:

m

fts message

Returns:

args as atoms array

fts_symbol_t fts_message_get_selector

(

fts_message_t *

m

)

Get the message selector.

Parameters:

m

fts message

Returns:

message selector

FTS_API void fts_message_set	(	fts_message_t *	mess,
		fts_symbol_t	s,
		int	ac,
		const fts_atom_t *	at
	)

Set message selector and arguments.

Parameters:

	mess	the message
	s	message symbol (selector)
	ac	argument count
	at	argument values

FTS_API void fts_message_set_from_atoms	(	fts_message_t *	mess,
		int	ac,
		const fts_atom_t *	at
	)

Set message from an array.

Parameters:

	mess	the message
	ac	array size
	at	array values