| Package | mx.messaging |
| Class | public class MessageAgent |
| Inheritance | MessageAgent EventDispatcher Object |
| Implements | IMXMLObject |
| Subclasses | Consumer , Producer |
메모: 확장된 사용만을 목적으로 하고 있습니다. 이 클래스는, 기존의 프로듀사크라스나 컨슈머(consumer) 클래스등의 custom 에이전트를 작성하는 경우에 사용합니다.
MXML 문장구조법
MXML 문장구조법의 비표시
Producer 및 Consumer 클래스등의 모든 메세지 에이전트 클래스는 MessageAgent 를 확장해, 이하의 태그 속성을 Inheritance합니다.
<mx:tagname
property channelSet="디폴트치 없음" clientId="디폴트치 없음" connected="false" destination="디폴트치 없음" requestTimeout="-1" subtopic="디폴트치 없음" event acknowledge="디폴트치 없음" channelConnect="디폴트치 없음" channelDisconnect="디폴트치 없음" channelFault="디폴트치 없음" fault="디폴트치 없음" propertyChange="디폴트치 없음" />
| property | 정의 | ||
|---|---|---|---|
| channelSet : ChannelSet
MessageAgent 가 사용하는 ChannelSet 에의 액세스를 제공합니다.
| MessageAgent | ||
| clientId : String
[read-only]
MessageAgent 의 클라이언트 ID 에의 액세스를 제공합니다.
| MessageAgent | ||
| connected : Boolean
[read-only]
이 MessageAgent 가 현재, ChannelSet 를 개입시켜 행선지에 접속되고 있는지 어떤지를 나타냅니다.
| MessageAgent | ||
![]() | constructor : Object
특정의 object 인스턴스의 클래스 object 또는 constructor 함수에의 참조입니다.
| Object | |
| destination : String
MessageAgent 의 행선지에의 액세스를 제공합니다.
| MessageAgent | ||
![]() | prototype : Object
[static]
클래스 또는 함수 object의 prototype object에의 참조입니다.
| Object | |
| requestTimeout : int
송신 메세지의 요구 타임 아웃 시간 (초단위)에 대한 액세스를 제공합니다.
| MessageAgent | ||
| subtopic : String
MessageAgent 가 사용하는 리모트 행선지의 subtopic에 액세스를 제공합니다.
| MessageAgent | ||
| Methods | 정의 | ||
|---|---|---|---|
| MessageAgent ()
constructor .
| MessageAgent | ||
| acknowledge (ackMsg:AcknowledgeMessage , msg:IMessage ):void
송신된 메세지의 결과를 수신했을 때에 MessageResponder 에 의해 불려 갑니다.
| MessageAgent | ||
![]() | addEventListener (type:String , listener:Function , useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
event listener objects를 EventDispatcher object에 등록해, listener가 이벤트의 통지를 받도록(듯이) 합니다.
| EventDispatcher | |
| channelConnectHandler (event:ChannelEvent ):void
CONNECT ChannelEvent 를 처리합니다.
| MessageAgent | ||
| channelDisconnectHandler (event:ChannelEvent ):void
DISCONNECT ChannelEvent 를 처리합니다.
| MessageAgent | ||
| channelFaultHandler (event:ChannelFaultEvent ):void
ChannelFaultEvent 를 처리합니다.
| MessageAgent | ||
| disconnect ():void
MessageAgent 의 네트워크 접속을 절단 합니다.
| MessageAgent | ||
![]() | dispatchEvent (event:Event ):Boolean
이벤트를 event 플로우(flow)에 dispatch합니다.
| EventDispatcher | |
| fault (errMsg:ErrorMessage , msg:IMessage ):void
송신된 메세지의 실패를 수신했을 때에, MessageResponder 에 의해 불려 갑니다.
| MessageAgent | ||
![]() | hasEventListener (type:String ):Boolean
EventDispatcher object에, 특정의 event 타입에 대해서 등록된 listener가 있을지 어떨지를 확인합니다.
| EventDispatcher | |
![]() | hasOwnProperty (name:String ):Boolean
object로 지정된 property가 정의되고 있는지 어떤지를 나타냅니다.
| Object | |
| initialized (document:Object , id:String ):void
Implements object가 작성되어 태그로 지정된 모든 property를 할당할 수 있었던 후에 불려 갑니다.
| MessageAgent | ||
![]() | isPrototypeOf (theClass:Object ):Boolean
Object 클래스의 인스턴스가, Parameters로서 지정된 object의 prototype 체인내에 있을지 어떨지를 나타냅니다.
| Object | |
| logout ():void
MessageAgent 를 리모트 행선지로부터 로그아웃 합니다.
| MessageAgent | ||
![]() | propertyIsEnumerable (name:String ):Boolean
지정된 property가 존재해, 열거 가능한가 어떤가를 나타냅니다.
| Object | |
![]() | removeEventListener (type:String , listener:Function , useCapture:Boolean = false):void
EventDispatcher object로부터 listener를 삭제합니다.
| EventDispatcher | |
| setCredentials (username:String , password:String ):void
MessageAgent 가 행선지의 인증에 사용하는 증명서를 설정합니다.
| MessageAgent | ||
![]() | setPropertyIsEnumerable (name:String , isEnum:Boolean = true):void
루프 처리에 대한 다이나믹 property의 가용성을 설정합니다.
| Object | |
| setRemoteCredentials (username:String , password:String ):void
세칸다리시스템에의 인증을 위해서(때문에) 리모트 행선지에 건네주는 리모트 자격 정보를 설정합니다.
| MessageAgent | ||
![]() | toString ():String
지정된 object의 string 표현을 돌려줍니다.
| Object | |
![]() | valueOf ():Object
지정된 object의 원시적치를 돌려줍니다.
| Object | |
![]() | willTrigger (type:String ):Boolean
지정된 event 타입에 대해, 이 EventDispatcher object 또는 그 조상에게 event listener가 등록되어 있는지 어떤지를 확인합니다.
| EventDispatcher | |
| Methods | 정의 | ||
|---|---|---|---|
| initChannelSet (message:IMessage ):void
MessageAgent 의 첫회의 접속전에 MessageAgent 의
channelSet property를 자동적으로 초기화합니다. | MessageAgent | ||
| internalSend (message:IMessage ):void
에이전트의 ChannelSet 를 사용해, MessageAgent 로부터 행선지로 메세지를 송신합니다.
| MessageAgent | ||
| 이벤트 | 일람 | 정의 | ||
|---|---|---|---|---|
| acknowledge | 송신한 메세지에 대한 응답 메세지를 수신했을 때에 dispatch됩니다. | MessageAgent | ||
| channelConnect | MessageAgent 가 사용중의 기본 채널이 접속되었을 때에 dispatch됩니다. | MessageAgent | ||
| channelDisconnect | MessageAgent 가 사용중의 기본 채널이 절단 되었을 때에 dispatch됩니다. | MessageAgent | ||
| channelFault | MessageAgent 가 사용중의 기본 채널로 에러가 발생했을 때에 dispatch됩니다. | MessageAgent | ||
| fault | 메세지 에러가 발생했을 때에 dispatch됩니다. | MessageAgent | ||
| propertyChange |
MessageAgent 의 connected property가 변경되었을 때에 dispatch됩니다. | MessageAgent | ||
| channelSet | property |
channelSet:ChannelSet [read-write]MessageAgent 가 사용하는 ChannelSet 에의 액세스를 제공합니다. ChannelSet 는 수동으로 작성해 할당할 수가 있습니다. 또, 이 MessageAgent 의 행선지에 대해서 설정 끝난 채널을 사용해, 동적으로 초기화할 수도 있습니다.
Implements public function get channelSet():ChannelSet
public function set channelSet(value:ChannelSet ):void
| clientId | property |
clientId:String [read-only]MessageAgent 의 클라이언트 ID 에의 액세스를 제공합니다. 에이전트에는, 리모트 행선지에 의해 클라이언트 ID 를 할당할 수 있습니다.
Implements public function get clientId():String
| connected | property |
connected:Boolean [read-only]
이 MessageAgent 가 현재, ChannelSet 를 개입시켜 행선지에 접속되고 있는지 어떤지를 나타냅니다. 이 property가 변경되면,propertyChange 이벤트가 dispatch됩니다.
이 property는 데이터 바인딩의 소스로서 사용할 수 있습니다.
Implements public function get connected():Boolean
| destination | property |
destination:String [read-write]MessageAgent 의 행선지에의 액세스를 제공합니다. MessageAgent 가 현재 접속되고 있는 경우, 행선지를 변경하면 절단 됩니다.
이 property는 데이터 바인딩의 소스로서 사용할 수 있습니다.
Implements public function get destination():String
public function set destination(value:String ):void
InvalidDestinationError — 행선지가 null 또는 길이가 0 의 경우.
|
| requestTimeout | property |
requestTimeout:int [read-write]송신 메세지의 요구 타임 아웃 시간 (초단위)에 대한 액세스를 제공합니다. 타임 아웃에 이르기 전에 리모트 행선지로부터 응답 또는 실패를 수신하지 않았던 경우, 메세지는 실패가 됩니다. 제로 이하의 값을 설정하면, 요구는 타임 아웃이 되지 않습니다.
Implements public function get requestTimeout():int
public function set requestTimeout(value:int ):void
| subtopic | property |
subtopic:String [read-write]MessageAgent 가 사용하는 리모트 행선지의 subtopic에 액세스를 제공합니다.
이 property는 데이터 바인딩의 소스로서 사용할 수 있습니다.
Implements public function get subtopic():String
public function set subtopic(value:String ):void
| MessageAgent | () | constructor |
public 함수 MessageAgent()constructor .
| acknowledge | () | Methods |
public function acknowledge(ackMsg:AcknowledgeMessage , msg:IMessage ):void
송신된 메세지의 결과를 수신했을 때에 MessageResponder 에 의해 불려 갑니다. 서브 클래스에서 custom 응답 처리를 실행할 필요가 있는 경우, 이 Methods를 서브 클래스에서 재정의(override) 할 수가 있습니다만,super.acknowledge() 도 호출할 필요가 있습니다. 이 Methods에 의해, MessageAckEvent 가 dispatch됩니다.
ackMsg:AcknowledgeMessage — 돌려주어지는 AcknowledgMessage 입니다.
|
|
msg:IMessage — 원의 송신 메세지입니다.
|
| channelConnectHandler | () | Methods |
public function channelConnectHandler(event:ChannelEvent ):void
CONNECT ChannelEvent 를 처리합니다. custom 처리의 실행이 필요한 서브 클래스에서 이 Methods를 재정의(override) 해,super.channelConnectHandler() 를 호출할 필요가 있습니다.
event:ChannelEvent — ChannelEvent 입니다.
|
| channelDisconnectHandler | () | Methods |
public function channelDisconnectHandler(event:ChannelEvent ):void
DISCONNECT ChannelEvent 를 처리합니다. custom 처리의 실행이 필요한 서브 클래스에서 이 Methods를 재정의(override) 해,super.channelDisconnectHandler() 를 호출할 필요가 있습니다.
event:ChannelEvent — ChannelEvent 입니다.
|
| channelFaultHandler | () | Methods |
public function channelFaultHandler(event:ChannelFaultEvent ):void
ChannelFaultEvent 를 처리합니다. custom 처리의 실행이 필요한 서브 클래스에서 이 Methods를 재정의(override) 해,super.channelFaultHandler() 를 호출할 필요가 있습니다.
event:ChannelFaultEvent — ChannelFaultEvent
|
| disconnect | () | Methods |
public function disconnect():void MessageAgent 의 네트워크 접속을 절단 합니다. 이 Methods는, 미처리의 네트워크 조작이 완료할 때까지 기다리는 것은 하지 않습니다.
| fault | () | Methods |
public function fault(errMsg:ErrorMessage , msg:IMessage ):void
송신된 메세지의 실패를 수신했을 때에, MessageResponder 에 의해 불려 갑니다. 서브 클래스에서 custom 실패 처리를 실행할 필요가 있는 경우, 이 Methods를 서브 클래스에서 재정의(override) 할 수가 있습니다만,super.fault() 도 호출할 필요가 있습니다. 이 Methods에 의해, MessageFaultEvent 가 dispatch됩니다.
errMsg:ErrorMessage — ErrorMessage 입니다.
|
|
msg:IMessage — 이 에러의 원인이 된 원의 송신 메세지입니다.
|
| initChannelSet | () | Methods |
protected function initChannelSet(message:IMessage ):void
MessageAgent 의 첫회의 접속전에 MessageAgent 의 channelSet property를 자동적으로 초기화합니다. 커스텀의 초기화를 실행하기 위해서, 아류형에 의해 재정의(override) 되는 일이 있습니다.
message:IMessage — 송신의 필요가 있는 메세지입니다.
|
| initialized | () | Methods |
public function initialized(document:Object , id:String ):void Implements object가 작성되어 태그로 지정된 모든 property를 할당할 수 있었던 후에 불려 갑니다.
Parametersdocument:Object — 이 object를 작성한 MXML 문서입니다.
|
|
id:String — 문서가 이 object를 참조하기 위해서 사용하는 ID. object가 문서의 deep property인 경우, ID 는 null 가 됩니다.
|
| internalSend | () | Methods |
protected final function internalSend(message:IMessage ):void 에이전트의 ChannelSet 를 사용해, MessageAgent 로부터 행선지로 메세지를 송신합니다. MessageAgent 의 서브 클래스는, 이 Methods를 사용해 메세지를 송신할 필요가 있습니다.
Parametersmessage:IMessage — 송신하는 메세지입니다.
|
InvalidDestinationError — 행선지가 설정되어 있지 않은 경우.
|
| logout | () | Methods |
public function logout():void
MessageAgent 를 리모트 행선지로부터 로그아웃 합니다. 행선지로부터의 로그아웃은, 서버 설정으로 지정되고 있는 것과 같은 ChannelSet 를 사용해 접속되고 있는 모든 것에 적용됩니다. 예를 들어, RTMP 채널로 복수의 DataService 컴퍼넌트가 접속되고 있어 그 중 1 개로 logout() 가 불려 갔을 경우, 같은 ChannelSet 를 사용해 접속하고 있는 그 외 모든 클라이언트 컴퍼넌트도 로그아웃 됩니다.
| setCredentials | () | Methods |
public function setCredentials(username:String , password:String ):void MessageAgent 가 행선지의 인증에 사용하는 증명서를 설정합니다. 증명서는, 같은 ChannelSet 상에서 접속 떠날 수 있어 모든 서비스에 적용됩니다.
Parametersusername:String — 유저명입니다.
|
|
password:String — 패스워드입니다.
|
| setRemoteCredentials | () | Methods |
public function setRemoteCredentials(username:String , password:String ):void 세칸다리시스템에의 인증을 위해서(때문에) 리모트 행선지에 건네주는 리모트 자격 정보를 설정합니다.
Parametersusername:String — 유저명입니다.
|
|
password:String — 패스워드입니다.
|
| acknowledge | event |
mx.messaging.events.MessageAckEvent
mx.messaging.events.MessageAckEvent.ACKNOWLEDGE
송신한 메세지에 대한 응답 메세지를 수신했을 때에 dispatch됩니다.
ACKNOWLEDGE 이벤트형. 확인 응답의 수신시에 dispatch됩니다.
이 정수의 값은 "acknowledge" 입니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
acknowledgeMessage | MessageEvent 의 메세지 property를 AcknowledgeMessage 로서 취득하기 위한 유틸리티 property입니다. |
bubbles | false |
cancelable | false |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
correlate | 이 응답에 관련지을 수 있었던 원의 메세지. |
message | 이 이벤트에 관련지을 수 있었던 메세지. |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
| channelConnect | event |
mx.messaging.events.ChannelEvent
mx.messaging.events.ChannelEvent.CONNECT
MessageAgent 가 사용중의 기본 채널이 접속되었을 때에 dispatch됩니다.
CONNECT 이벤트형. 채널이 엔드 포인트에 접속된 것을 나타냅니다.
이 정수의 값은 "channelConnect" 입니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
channel | 이 이벤트가 방아쇠 된 채널입니다. |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
reconnecting | 이 이벤트를 생성한 채널이 재접속중인가 어떤가를 나타냅니다. |
rejected | 이 이벤트를 생성한 채널이 거부되었는지 어떠했는지를 나타냅니다. 액티버티가 없는 것에보다 채널이 절단 되었을 경우는, 이것이 true 가 되어, 페이르오바를 하지 않고, 대체 채널에의 접속도 행해지지 않습니다. |
| channelDisconnect | event |
mx.messaging.events.ChannelEvent
mx.messaging.events.ChannelEvent.DISCONNECT
MessageAgent 가 사용중의 기본 채널이 절단 되었을 때에 dispatch됩니다.
DISCONNECT 이벤트형. 채널이 엔드 포인트로부터 절단 된 것을 나타냅니다.
이 정수의 값은 "channelDisconnect" 입니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
channel | 이 이벤트가 방아쇠 된 채널입니다. |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
reconnecting | 이 이벤트를 생성한 채널이 재접속중인가 어떤가를 나타냅니다. |
rejected | 이 이벤트를 생성한 채널이 거부되었는지 어떠했는지를 나타냅니다. 액티버티가 없는 것에보다 채널이 절단 되었을 경우는, 이것이 true 가 되어, 페이르오바를 하지 않고, 대체 채널에의 접속도 행해지지 않습니다. |
| channelFault | event |
mx.messaging.events.ChannelFaultEvent
mx.messaging.events.ChannelFaultEvent.FAULT
MessageAgent 가 사용중의 기본 채널로 에러가 발생했을 때에 dispatch됩니다.
FAULT 이벤트형. fault가 발생한 채널을 나타냅니다.
이 정수의 값은 "channelFault" 입니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
channel | 이 이벤트를 생성한 채널. |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
faultCode | 실패에 관한 행선지 고유의 상세를 제공합니다. |
faultDetail | 실패의 행선지 고유의 이유에의 액세스를 제공합니다. |
faultString | 채널 자체가 fault를 생성하지 않았던 경우는, fault의 근본적인 이유에의 액세스를 제공합니다. |
reconnecting | 이 이벤트를 생성한 채널이 재접속중인가 어떤가를 나타냅니다. |
rootCause | 채널 자체가 fault를 생성하지 않았던 경우는, fault의 근본적인 이유에의 액세스를 제공합니다. |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
| fault | event |
mx.messaging.events.MessageFaultEvent
mx.messaging.events.MessageFaultEvent.FAULT
메세지 에러가 발생했을 때에 dispatch됩니다.
FAULT 이벤트형. 메세지 fault의 발생시에 dispatch됩니다.
이 정수의 값은 "fault" 입니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
faultCode | 실패에 관한 행선지 고유의 상세를 제공합니다. |
faultDetail | 실패의 행선지 고유의 이유에의 액세스를 제공합니다. |
faultString | 채널 자체가 fault를 생성하지 않았던 경우는, fault의 근본적인 이유에의 액세스를 제공합니다. |
message | 이 이벤트의 ErrorMessage. |
rootCause | 실패의 근본적인 이유에의 액세스를 제공합니다 (존재하는 경우). |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
| propertyChange | event |
mx.events.PropertyChangeEvent
mx.events.PropertyChangeEvent.PROPERTY_CHANGE
MessageAgent 의 connected property가 변경되었을 때에 dispatch됩니다. 또, 컨슈머(consumer)의 예약(subscribe)d 가 변경되었을 때에도 dispatch됩니다.
PropertyChangeEvent.PROPERTY_CHANGE 정수에 의해,PropertyChange 이벤트의 event object의 type property치가 정의됩니다.
event object의 각 property에는 다음의 값이 설정됩니다.
| Property | Value |
|---|---|
bubbles | constructor 에 의해 결정됩니다. 디폴트는 false 입니다. |
cancelable | constructor 에 의해 결정됩니다. 디폴트는 false 입니다. |
kind | 변경의 종류. PropertyChangeEventKind.UPDATE 또는 PropertyChangeEventKind.DELETE 의 머지않아인가입니다. |
oldValue | 원의 property의 값입니다. |
newValue | 새로운 property의 값 (존재하는 경우)입니다. |
property | 변경된 property입니다. |
source | 변경된 property를 포함한 object입니다. |
currentTarget | 이벤트를 처리하는 event listener를 정의하는 object. 예를 들어, event listener의 등록에 myButton.addEventListener() 를 사용하면,currentTarget 의 값은 "myButton" 가 됩니다. |
target | 이벤트를 dispatch한 object를 나타냅니다. 이 object는 반드시 이벤트를 받는 object라고는 할 수 없습니다. 이벤트를 받는 object에 항상 액세스 하려면 ,currentTarget property를 사용해 주세요. |
See also
코멘트가 추가되었을 경우, 메일로 받기. | 코멘트 리포트
현재의 페이지: http://flexdocs.kr/docs/flex2/langref/mx/messaging/MessageAgent.html