LibMC::MCAclMessage Class Reference

Enum for describing the type of an ACL message.

Note:

This enum is pulled directly from the Mobile-C library.

Enumerator:

FIPA_ERROR Fipa performative enum value

FIPA_ZERO Fipa performative enum value

FIPA_ACCEPT_PROPOSAL Fipa performative enum value

FIPA_AGREE Fipa performative enum value

FIPA_CANCEL Fipa performative enum value

FIPA_CALL_FOR_PROPOSAL Fipa performative enum value

FIPA_CONFIRM Fipa performative enum value

FIPA_DISCONFIRM Fipa performative enum value

FIPA_FAILURE Fipa performative enum value

FIPA_INFORM Fipa performative enum value

FIPA_INFORM_IF Fipa performative enum value

FIPA_INFORM_REF Fipa performative enum value

FIPA_NOT_UNDERSTOOD Fipa performative enum value

FIPA_PROPOGATE Fipa performative enum value

FIPA_PROPOSE Fipa performative enum value

FIPA_PROXY Fipa performative enum value

FIPA_QUERY_IF Fipa performative enum value

FIPA_QUERY_REF Fipa performative enum value

FIPA_REFUSE Fipa performative enum value

FIPA_REJECT_PROPOSAL Fipa performative enum value

FIPA_REQUEST Fipa performative enum value

FIPA_REQUEST_WHEN Fipa performative enum value

FIPA_REQUEST_WHENEVER Fipa performative enum value

FIPA_SUBSCRIBE Fipa performative enum value

Definition at line 79 of file MCAclMessage.cs.

Default constructor.

Creates an empty ACL message object.

Definition at line 114 of file MCAclMessage.cs.

References aclmsg_p.

Referenced by Reply().

Definition at line 120 of file MCAclMessage.cs.

References AclMsg.

Creates a new, blank ACL message.

Creates a new ACL message. The message is blank but valid.

Definition at line 153 of file MCAclMessage.cs.

References AclMsg.

Creates an ACL message that is a response to the argument.

Creates an ACL message to respond to the argument.

Parameters:

acl_message The message from which to create the reply.

Returns:

A new ACL message that is a response to the argument or an empty message if there is an error.

Definition at line 167 of file MCAclMessage.cs.

References AclMsg, and MCAclMessage().

Sets the performative field of the message.

Sets the performative field of the message.

Parameters:

performative The fipa_performative_e enum describing the message.

Returns:

The return value of the underlying MC_AclSetPerformative function.

Note:

The message must be a valid message or this function will fail.

Definition at line 186 of file MCAclMessage.cs.

References AclMsg.

Sets the sender field of the message.

Sets the performative field of the message.

Parameters:

name The name of the sending entity.

address The address of the sending entity.

Returns:

The return value of the underlying MC_AclSetSender function.

Note:

The message must be a valid message or this function will fail.

Definition at line 202 of file MCAclMessage.cs.

References AclMsg.

Adds a receiver to the list of receivers.

Adds a receiver to the list of receivers for the message.

Parameters:

name The name of the receiver.

address The address of the receiver.

Returns:

The return value of the underlying MC_AclAddReceiver function.

Note:

The message must be a valid message or this function will fail.

Definition at line 218 of file MCAclMessage.cs.

References AclMsg.

Adds a "reply-to" field to the message.

Adds a "reply-to" field to the message. The reply-to field overrides the sender field when creating a reply.

Parameters:

name The name of the receiver.

address The address of the receiver.

Returns:

The return value of the underlying MC_AclAddAddReplyTo function.

Note:

The message must be a valid message or this function will fail.

Definition at line 235 of file MCAclMessage.cs.

References AclMsg.

Sets the content field of the message.

Sets the content field of the message.

Parameters:

content The string to copy to the content field.

Returns:

The return value of the underlying MC_AclSetContent function.

Note:

The message must be a valid message or this function will fail.

Definition at line 250 of file MCAclMessage.cs.

References AclMsg.

Destroys a message.

This function destroys a message in the Mobile-C library. It releases the underlying memory and must be called when the message is no longer needed.

Returns:

The return value of the underlying MC_AclDestroy function.

Note:

The message must be a valid message or this function will fail. In addition, messages are not automatically destroyed by the garbage collector. Use care when creating messages and ensure they are properly destroyed.

Definition at line 269 of file MCAclMessage.cs.

References AclMsg, and aclmsg_p.

Definition at line 105 of file MCAclMessage.cs.

Referenced by Destroy(), and MCAclMessage().

Definition at line 129 of file MCAclMessage.cs.

Referenced by LibMC::MCAgent::AclPost(), LibMC::MCAgency::AclSend(), AddReceiver(), AddReplyTo(), Destroy(), MCAclMessage(), New(), Reply(), SetContent(), SetPerformative(), and SetSender().