LibMC.MCAclMessage Class Reference

Encapsulates ACL messages in the Mobile-C library. More...

List of all members.

Public Types

enum  MC_FipaPerformative_e
 Enum for describing the type of an ACL message. More...

Public Member Functions

 MCAclMessage ()
 Default constructor.
void New ()
 Creates a new, blank ACL message.
MCAclMessage Reply (MCAclMessage acl_message)
 Creates an ACL message that is a response to the argument.
int SetPerformative (MC_FipaPerformative_e performative)
 Sets the performative field of the message.
int SetSender (String name, String address)
 Sets the sender field of the message.
int AddReceiver (String name, String address)
 Adds a receiver to the list of receivers.
int AddReplyTo (String name, String address)
 Adds a "reply-to" field to the message.
int SetContent (String content)
 Sets the content field of the message.
int Destroy ()
 Destroys a message.

Detailed Description

Encapsulates ACL messages in the Mobile-C library.

This class contains a pointer to an ACL message in the Mobile-C library. Functions are provided to send the message, set its various fields, and destory the message.

Definition at line 72 of file MCAclMessage.cs.

Member Enumeration Documentation

enum LibMC::MCAclMessage::MC_FipaPerformative_e

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.

Constructor & Destructor Documentation

LibMC.MCAclMessage.MCAclMessage (  ) 

Default constructor.

Creates an empty ACL message object.

Definition at line 114 of file MCAclMessage.cs.

Referenced by LibMC.MCAclMessage.Reply().

Member Function Documentation

void LibMC.MCAclMessage.New (  ) 

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.

MCAclMessage LibMC.MCAclMessage.Reply ( MCAclMessage  acl_message  ) 

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 LibMC.MCAclMessage.AclMsg, and LibMC.MCAclMessage.MCAclMessage().

int LibMC.MCAclMessage.SetPerformative ( MC_FipaPerformative_e  performative  ) 

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.

int LibMC.MCAclMessage.SetSender ( String  name,
String  address 
)

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.

int LibMC.MCAclMessage.AddReceiver ( String  name,
String  address 
)

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.

1BF|/uf6dUOʬ,_;Ft`v*xEԵ}KށO?}Ϊ Q㛧4fqLɶ c3yTʌ1kN]VìEpR0$z!y=Ȑ=mFn.}^Y?/30VvB̠E%ܴ@ÑV}"%nL - x۬'Πwo\}jPQj1,e:a!R/Yȳj_X i>ãHSQ3d-i_5ʓi Q]BA[fWʬT=܏Kk{c{˯'3pQΚF0,|,q[VnT%C6KꢻE[^jW֠UBc V/}I@aO)NwRs.&ѓe=?lzMJ'wܙ˕Ba:7zk%W=ȞAAi*)wԻZ.T3 \r\7GooRlTDԿjl IM[b8Β)bElkݯ]*x~.ƶTڄ*q<8-'#b4 Wftv)=}nhAp3C'WlJ/ SmTGq)?a~N[P?g[*9p해}RgnmatK2!y 'S+=ޟ~7Nf0 9:BZ' @B-J=٨:4κZg_G :a.P`;_=E ` .i0H7[ ,zNJ#32R\ӓYففq4M2٭Ln,jv5LlK`ku4kы7yLM;f_8s?]CN@PkTe?%qVN#pzz*>T̑\dFnDFj ʰɰ.&SϐC#?,Y-#-?ۗ#K\!M:i?]UZ{ҵm7CB\O,:GOtΰ?j /%)"]/ P7/kp$]i+J)mE ? YPu Fvk~.)F'5+?",^o~U^/E$@vT͠|(B%= +bs 0^rE+,DC\T x5; )+Bea]C3Lv PP3/l0؜mGۿx&ʳxpwG3VfQ?t}GKh?et}؎E}3HI׫dcl5T}X[F#:T*c-7 Y佉-*~Pjزe\ឮr bE@BK;mRf >sv_IW|YˍOOǼ7kV4#N|?ҞѹjIvvRȖZ^^QL6uIYgx<|=0VHz2soZC ̯<"RrghO#O8Dk۶.OatXbc(lv:М7>,Zn9B1'=HtAɱ6ahT>;z޾[,S4NJ|Cmy!S\-ظ X!>O㨒 GSlh^L#6s01@1<4!RW.8]Dy%HC`,QV\<◅!\<)TS4Mo`h~V򇬐 ) )R}Rt2I|Y&j7_X\tatLŝP}$P`;ǹ? !ɝ x[:Ƕb<'+(6BW\! gP -f^uTk\͖KL&3#|;:\,f~e:M8Dzfs\ј67&18FiA"˯w^Ȟ͛'?ނ;H-săhv}Fv&*+"X&ԭЇk{n3c`=3ʠP0-}F]b~79vVĪUeg Άb۫`RaYY(MI mu鼏ֿO͎tz3?X8;N<7i^@liE2#;!V|vգNNgI_p,A~5'2[x;*JazW¹kvRɷjIݶf:yWtͫ ~Cj|ڽ߫9*Rڙ`zJlGOHّ. HT\sGqd0B~l]DT{Fo2S~&e{Yo;W*EV3Fm+#?%gt:1mҨ׆O]uMF
int LibMC.MCAclMessage.AddReplyTo ( String  name,
String  address