| Package | org.samchon.protocol.invoke |
| Class | public class Invoke |
| Inheritance | Invoke  EntityArray mx.collections.ArrayCollection |
Standard message of network I/O.
Invoke is a class used in network I/O in protocol package of Samchon Framework.
The Invoke message has an XML structure like the result screen of provided example in below. We can enjoy lots of benefits by the normalized and standardized message structure used in network I/O.
The greatest advantage is that we can make any type of network system, even how the system is enourmously complicated. As network communication message is standardized, we only need to concentrate on logical relationships between network systems. We can handle each network system like a object (class) in OOD. And those relationships can be easily designed by using design pattern.
In Samchon Framework, you can make any type of network system with basic 3 + 1 componenets (IProtocol, IServer and IClient + ServerConnector), by implemens or inherits them, like designing classes of S/W architecture.
Default MXML Propertysource
| Property | Defined By | ||
|---|---|---|---|
| CHILD_TAG : String [override] [read-only] | Invoke | ||
 | key : * [read-only] | EntityArray | |
| TAG : String [override] [read-only] | Invoke | ||
| Method | Defined By | ||
|---|---|---|---|
Invoke(... args)
Multiple Constructors. | Invoke | ||
at(index:int):InvokeParameter
Get the InvokeParameter at specified index. | Invoke | ||
construct(xml:XML):void [override] | Invoke | ||
createChild(xml:XML):IEntity [override] | Invoke | ||
| erase(key:*):Boolean | EntityArray | |
get(key:String):InvokeParameter
Access the InvokeParameter by specified identifier(parameter's name). | Invoke | ||
getArguments():Array
Get arguments. | Invoke | ||
getListener():String
Get listener. | Invoke | ||
| has(key:*):Boolean | EntityArray | |
setListener(val:String):void
Set listener. | Invoke | ||
toXML():XML [override] | Invoke | ||
| CHILD_TAG | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesCHILD_TAG:String [read-only] [override] public function get CHILD_TAG():String| TAG | property |
TAG:String [read-only] [override] public function get TAG():String| Invoke | () | Constructor |
public function Invoke(... args)
Multiple Constructors.
listener := Represents who listens the Invoke message. Almost same with Function name.
Creates Invoke and InvokeParameter(s) at the same time by varadic template method.
By the varadic template constructor, you can't specify name of each InvokeParameter, but specify type and value of each InvokeParameter. If you try to record the Invoke to Database, the name of InvokeParameter will be NULL.
By the varadic template constructor, name of InovkeParameter(s) will be omitted. Because of name, an identifier of an InvokeParameter, is omitted, you can't access to InvokeParameter by Invoke::has() or Invoke::get().
listener := Represents who listens the Invoke message. Almost same with Function name.
arguments := Arguments to be parameters of Invoke.
Constructs Invoke and InvokeParameter objects by an XML object.
xml := An xml object representing Invoke object.
Parameters... args |
| at | () | method |
public function at(index:int):InvokeParameter
Get the InvokeParameter at specified index.
Parameters
index:int — the index in the Invoke from which to retrieve the InvokeParameter
|
InvokeParameter — the InvokeParameter at that index
|
RangeError — if the index < 0 or index >= length
|
| construct | () | method |
override public function construct(xml:XML):voidParameters
xml:XML |
| createChild | () | method |
| get | () | method |
public function get(key:String):InvokeParameter
Access the InvokeParameter by specified identifier(parameter's name).
Parameters
key:String — the identifier of the InvokeParameter wants to access
|
InvokeParameter — The InvokeParameter having the key, or null if there is none.
|
| getArguments | () | method |
public function getArguments():ArrayGet arguments.
ReturnsArray |
| getListener | () | method |
public function getListener():String
Get listener.
ReturnsString |
| setListener | () | method |
public function setListener(val:String):void
Set listener.
Parameters
val:String |
| toXML | () | method |
override public function toXML():XMLReturnsXML |