WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 운영 체제: Linux, Windows

Message

Message 오브젝트는 응용프로그램이 전송하거나 수신하는 메시지를 표시합니다.

상속 계층 구조:
xms::PropertyContext
   |
   +----xms::Message

Message 오브젝트의 JMS 메시지 헤더 필드 목록은 XMS 메시지의 헤더 필드를 참조하십시오. Message 오브젝트의 JMS 정의 등록 정보 목록은 메시지의 JMS 정의 등록 정보를 참조하십시오. Message 오브젝트의 IBM 정의 등록 정보 목록은 메시지의 IBM 정의 등록 정보를 참조하십시오.

관련 참조
XMS 메시지

메소드

메소드 요약:
메소드 설명
~Message 메시지를 삭제합니다.
acknowledge 이 메시지를 비롯하여 세션이 이전에 수신한 메시지 중 수신확인되지 모든 메시지를 수신확인합니다.
clearBody 메시지 본문을 지웁니다.
clearProperties 메시지 등록 정보를 지웁니다.
getHandle C 응용프로그램이 메시지에 액세스하기 위해 사용할 핸들을 가져옵니다.
getJMSCorrelationID 메시지의 상관 ID를 가져옵니다.
getJMSDeliveryMode 메시지 전달 모드를 가져옵니다.
getJMSDestination 메시지 목적지를 가져옵니다.
getJMSExpiration 메시지의 만기 시간을 가져옵니다.
getJMSMessageID 메시지의 메시지 ID를 가져옵니다.
getJMSPriority 메시지 우선순위를 가져옵니다.
getJMSRedelivered 메시지 재전달 여부를 나타내는 표시를 가져옵니다.
getJMSReplyTo 응답 메시지가 전송될 목적지를 가져옵니다.
getJMSTimestamp 메시지가 전송된 시간을 가져옵니다.
getJMSType 메시지의 유형을 가져옵니다.
getProperties 메시지의 등록 정보 목록을 가져옵니다.
isNull Message 오브젝트가 널 오브젝트인지 여부를 판별합니다.
propertyExists 지정된 이름의 등록 정보가 메시지에 있는지 검사합니다.
setJMSCorrelationID 메시지의 상관 ID를 설정합니다.
setJMSDeliveryMode 메시지 전달 모드를 설정합니다.
setJMSDestination 메시지의 목적지를 설정합니다.
setJMSExpiration 메시지의 만기 시간을 가져오고 설정합니다.
setJMSMessageID 메시지의 메시지 ID를 설정합니다.
setJMSPriority 메시지의 우선순위를 설정합니다.
setJMSRedelivered 메시지 재전달 여부를 나타냅니다.
setJMSReplyTo 응답 메시지가 전송될 목적지를 설정합니다.
setJMSTimestamp 메시지가 전송된 시간을 설정합니다.
setJMSType 메시지의 유형을 설정합니다.

~Message – 메시지 삭제

인터페이스:
virtual ~Message();

메시지를 삭제합니다.

응용프로그램이 이미 삭제된 메시지를 삭제하려고 하면 호출이 무시됩니다.

매개변수:
없음
예외:
  • XMS_X_GENERAL_EXCEPTION

acknowledge – 수신확인

인터페이스:
xmsVOID acknowledge();

이 메시지를 비롯하여 세션이 이전에 수신한 메시지 중 수신확인되지 모든 메시지를 수신확인합니다.

세션의 수신확인 모드가 XMSC_CLIENT_ACKNOWLEDGE일 경우 응용프로그램은 이 메소드를 호출할 수 있습니다. 세션이 다른 수신확인 모드에 있거나 트랜잭트된 세션일 경우 이 메소드에 대한 호출이 무시됩니다.

수신만 하고 수신확인되지 않은 메시지는 재전달할 수 있습니다.

메시지 수신확인에 대한 자세한 정보는 세션의 메시지 수신확인을 참조하십시오.

매개변수:
없음
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

clearBody – 본문 지우기

인터페이스:
xmsVOID clearBody();

메시지 본문을 지웁니다. 헤더 필드와 메시지 등록 정보는 지워지지 않습니다.

응용프로그램이 메시지 본문을 지울 경우 이 본문의 상태는 새로 작성한 메시지의 빈 본문과 같은 상태입니다. 새로 작성한 메시지의 빈 본문의 상태는 메시지 본문의 유형에 따라 다릅니다. 자세한 정보는 XMS 메시지 본문을 참조하십시오.

응용프로그램은 본문 상태에 관계없이 언제든지 메시지 본문을 지울 수 있습니다. 메시지 본문이 읽기 전용일 경우 응용프로그램이 본문에 기록할 수 있는 유일한 방법은 먼저 본문을 지우는 것입니다.

매개변수:
없음
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

clearProperties – 등록 정보 지우기

인터페이스:
xmsVOID clearProperties();

메시지 등록 정보를 지웁니다. 헤더 필드와 메시지 본문은 지워지지 않습니다.

응용프로그램이 메시지 등록 정보를 지울 경우 등록 정보는 읽기 및 쓰기가 가능해집니다.

응용프로그램은 등록 정보의 상태에 관계없이 언제든지 메시지 등록 정보를 지울 수 있습니다. 메시지 등록 정보가 읽기 전용일 경우 쓰기 가능한 등록 정보가 될 수 있는 유일한 방법은 응용프로그램이 먼저 등록 정보를 지우는 것입니다.

매개변수:
없음
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

getHandle – 핸들 가져오기

인터페이스:
xmsHMsg getHandle() const;

C 응용프로그램이 메시지에 액세스하기 위해 사용할 핸들을 가져옵니다.

매개변수:
없음
리턴값:
메시지의 핸들입니다.
스레드 컨텍스트:
임의
예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSCorrelationID – JMSCorrelationID 가져오기

인터페이스:
String getJMSCorrelationID() const;

메시지의 상관 ID를 가져옵니다.

매개변수:
없음
리턴값:
상관 ID를 캡슐화하는 String 오브젝트입니다.
예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSDeliveryMode – JMSDeliveryMode 가져오기

인터페이스:
xmsINT getJMSDeliveryMode() const;

메시지 전달 모드를 가져옵니다. 전달 모드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정됩니다.

매개변수:
없음
리턴값:
다음 값 중 하나를 메시지 전달 모드로 사용할 수 있습니다.
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

아직 전송하지 않은 새로 작성한 메시지의 전달 모드는 XMSC_DELIVERY_PERSISTENT지만, 브로커에 대한 실시간 연결의 전달 모드는 XMSC_DELIVERY_NON_PERSISTENT입니다. 수신한 메시지의 경우, 수신 응용프로그램이 setJMSDeliveryMode()을 호출하여 전달 모드를 변경하지 않는 한 이 메소드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정된 전달 모드를 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSDestination – JMSDestination 가져오기

인터페이스:
Destination getJMSDestination() const;

메시지 목적지를 가져옵니다. 목적지는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정됩니다.

매개변수:
없음
리턴값:
Destination 오브젝트입니다.

아직 전송하지 않은 새로 작성한 메시지의 경우, 전송 응용프로그램이 setJMSDestination()을 호출하여 목적지를 설정하지 않는 한 이 메소드는 널 Destination 오브젝트를 리턴하고 오류 코드가 XMS_E_NOT_SET인 예외를 처리합니다. 수신한 메시지의 경우, 수신 응용프로그램이 setJMSDestination()을 호출하여 목적지를 변경하지 않는 한 이 메소드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정된 목적지에 대해 Destination 목적지를 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSExpiration – JMSExpiration 가져오기

인터페이스:
xmsLONG getJMSExpiration() const;

메시지의 만기 시간을 가져옵니다.

만기 시간은 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정됩니다. 만기 시간 값은 전송 응용프로그램이 지정한 TTL(Time to Live)을 메시지 전송 시간에 더한 값으로, 이 만기 시간은 1970년 1월 1일 00:00:00 GMT 이후부터 밀리초 단위로 표시됩니다.

TTL(Time to Live)이 0일 경우 MessageProducer.send() 호출은 만기 시간을 0으로 설정하여 메시지가 만기되지 않음을 나타냅니다.

XMS 만기된 메시지를 버리고 이를 응용프로그램에 전달하지 않습니다.

매개변수:
없음
리턴값:
메시지의 만기 시간입니다.

For a newly created message that has not been sent, the expiration time is 0 unless the sending application sets a different expiration time by calling setJMSExpiration(). 수신한 메시지의 경우, 수신 응용프로그램이 setJMSExpiration()을 호출하여 만기 시간을 변경하지 않는 한 이 메소드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정된 만기 시간을 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSMessageID – JMSMessageID 가져오기

인터페이스:
String getJMSMessageID() const;

메시지의 메시지 ID를 가져옵니다. 메시지 ID는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정됩니다.

매개변수:
없음
리턴값:
메시지 ID를 캡슐화하는 String 오브젝트입니다.

수신한 메시지의 경우, 수신 응용프로그램이 setJMSMessageID()를 호출하여 메시지 ID를 변경하지 않는 한 이 메소드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정된 메시지 ID를 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION
참고:
  1. 메시지에 메시지 ID가 없을 경우 이 메소드는 오류 코드가 XMS_E_NOT_SET인 예외를 처리합니다.

getJMSPriority – JMSPriority 가져오기

인터페이스:
xmsINT getJMSPriority() const;

메시지 우선순위를 가져옵니다. 우선순위는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정됩니다.

매개변수:
없음
리턴값:
메시지의 우선순위입니다. 값은 0(가장 낮은 우선순위) - 9(가장 높은 우선순위) 범위에 있는 정수입니다.

아직 전송하지 않은 새로 작성한 메시지의 경우 전송 응용프로그램이 setJMSPriority()를 호출하여 다른 우선순위를 설정하지 않는 한 우선순위는 4입니다. 수신한 메시지의 경우, 수신 응용프로그램이 tJoSExPtn(tnoy을 호출하여 우선순위를 변경하지 않는 한 이 메소드는 메시지를 전송할 때 setJMSPriority() 호출에 의해 설정된 우선순위를 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSRedelivered – JMSRedelivered 가져오기

인터페이스:
xmsBOOL getJMSRedelivered() const;

메시지 재전달 여부를 나타내는 표시를 가져옵니다. 이 표시는 메시지를 수신할 때 IMessageConsumer.receive() 호출에 의해 설정됩니다.

매개변수:
없음
리턴값:
  • xmsTRUE - 메시지를 재전달할 경우
  • xmsFALSE - 메시지를 재전달하지 않을 경우

브로커에 대한 실시간 연결의 경우 이 메소드는 항상 xmsFALSE를 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSReplyTo – JMSReplyTo 가져오기

인터페이스:
Destination getJMSReplyTo() const;

응답 메시지가 전송될 목적지를 가져옵니다.

매개변수:
없음
리턴값:
응답 메시지가 전송될 목적지를 가져오고 설정합니다. 널 Destination 오브젝트는 응답이 필요하지 않음을 의미합니다.
예외:
  • XMS_X_GENERAL_EXCEPTION

getJMSTimestamp – JMSTimestamp 가져오기

인터페이스:
xmsLONG getJMSTimestamp() const;

메시지가 전송된 시간을 가져옵니다. 시간 소인은 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정되며, 1970년 1월 1일 00:00:00 GMT 이후부터 밀리초 단위로 표시됩니다.

매개변수:
없음
리턴값:
메시지가 전송된 시간입니다.

아직 전송하지 않은 새로 작성한 메시지의 경우 전송 응용프로그램이 setJMSTimestamp()를 호출하여 다른 시간 소인을 설정하지 않는 한 시간 소인은 0입니다. 수신한 메시지의 경우, 수신 응용프로그램이 setJMSTimestamp()를 호출하여 시간 소인을 변경하지 않는 한 이 메소드는 메시지를 전송할 때 MessageProducer.send() 호출에 의해 설정된 시간 소인을 리턴합니다.

예외:
  • XMS_X_GENERAL_EXCEPTION
참고:
  1. 시간 소인이 정의되어 있지 않은 경우 이 메소드는 0만 리턴하고 예외를 처리하지는 않습니다.

getJMSType – JMSType 가져오기

인터페이스:
String getJMSType() const;

메시지의 유형을 가져옵니다.

매개변수:
없음
리턴값:
메시지의 유형을 캡슐화하는 String 오브젝트입니다. 데이터 변환이 필수인 경우 이 매개변수는 변환 후 유형입니다.
예외:
  • XMS_X_GENERAL_EXCEPTION

getProperties – 등록 정보 가져오기

인터페이스:
Iterator getProperties() const;

메시지의 등록 정보 목록을 가져옵니다.

이 메소드는 Property 오브젝트의 목록을 캡슐화하는 반복기를 리턴합니다. 응용프로그램은 반복기를 사용하여 각 등록 정보에 차례로 액세스할 수 있습니다.

주: 이와 동등한 JMS 메소드는 약간 다른 기능을 수행합니다. JMS 메소드는 메시지 등록 정보의 값이 아니라 이름 목록만 리턴합니다.
매개변수:
없음
리턴값:
Iterator 오브젝트입니다.
예외:
  • XMS_X_GENERAL_EXCEPTION

isNull – 널 여부 확인

인터페이스:
xmsBOOL isNull() const;

Message 오브젝트가 널 오브젝트인지 여부를 판별합니다.

매개변수:
없음
리턴값:
  • xmsTRUE - Message 오브젝트가 널 오브젝트인 경우
  • xmsFALSE - Message 오브젝트가 널 오브젝트가 아닌 경우
예외:
  • XMS_X_GENERAL_EXCEPTION

propertyExists – 등록 정보 존재 여부 검사

인터페이스:
xmsBOOL propertyExists(const String & propertyName) const;

지정된 이름의 등록 정보가 메시지에 있는지 검사합니다.

매개변수:
propertyName(입력)
등록 정보의 이름을 캡슐화하는 String 오브젝트입니다.
리턴값:
  • xmsTRUE - 지정된 이름의 등록 정보가 메시지에 있는 경우
  • xmsFALSE - 지정된 이름의 등록 정보가 메시지에 없는 경우
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSCorrelationID – JMSCorrelationID 설정

인터페이스:
xmsVOID setJMSCorrelationID(const String correlID);

메시지의 상관 ID를 설정합니다.

매개변수:
correlID(입력)
상관 ID를 캡슐화하는 String 오브젝트입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSDeliveryMode – JMSDeliveryMode 설정

인터페이스:
xmsVOID setJMSDeliveryMode(const xmsINT deliveryMode);

메시지 전달 모드를 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 전달 모드는 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 전달 모드를 변경할 수 있습니다.

매개변수:
deliveryMode(입력)
메시지 전달 모드로 다음 값 중 하나를 사용할 수 있습니다.
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSDestination – JMSDestination 설정

인터페이스:
xmsVOID setJMSDestination(const Destination & destination);

메시지의 목적지를 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 목적지는 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 목적지를 변경할 수 있습니다.

매개변수:
destination(입력)
메시지 목적지를 나타내는 Destination 오브젝트입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSExpiration – JMSExpiration 설정

인터페이스:
xmsVOID setJMSExpiration(const xmsLONG expiration);

메시지의 만기 시간을 가져오고 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 만기 시간은 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 만기 시간을 변경할 수 있습니다.

매개변수:
expiration(입력)
이 메시지의 만기 시간은 1970년 1월 1일 00:00:00 GMT 이후부터 밀리초 단위로 표시됩니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSMessageID – JMSMessageID 설정

인터페이스:
xmsVOID setJMSMessageID(const String & msgID);

메시지의 메시지 ID를 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 메시지 ID는 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 메시지 ID를 변경할 수 있습니다.

매개변수:
msgID(입력)
메시지 ID를 캡슐화하는 String 오브젝트입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSPriority – JMSPriority 설정

인터페이스:
xmsVOID setJMSPriority(const xmsINT priority);

메시지의 우선순위를 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 우선순위는 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 우선순위를 변경할 수 있습니다.

매개변수:
priority(입력)
메시지의 우선순위입니다. 값은 0(가장 낮은 우선순위) - 9(가장 높은 우선순위) 범위에 있는 정수입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSRedelivered – JMSRedelivered 설정

인터페이스:
xmsVOID setJMSRedelivered(const xmsBOOL redelivered);

메시지 재전달 여부를 나타냅니다.

메시지가 전송되기 전에 이 메소드에 의해 설정된 재전달 표시는 메시지를 전송할 경우 MessageProducer.send() 호출에 의해 무시되며, 메시지를 수신할 경우 MessageConsumer.receive() 호출에 의해 무시되어 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 재전달 표시를 변경할 수 있습니다.

매개변수:
redelivered(입력)
xmsTRUE 값은 메시지가 재전달된다는 의미입니다. xmsFALSE 값은 메시지가 재전달되지 않는다는 의미입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSReplyTo – JMSReplyTo 설정

인터페이스:
xmsVOID setJMSReplyTo(const Destination & destination);

응답 메시지가 전송될 목적지를 설정합니다.

매개변수:
destination(입력)
응답 메시지가 전송될 목적지를 나타내는 Destination 오브젝트입니다. 널 Destination 오브젝트는 응답이 필요하지 않음을 의미합니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSTimestamp – JMSTimestamp 설정

인터페이스:
xmsVOID setJMSTimestamp(const xmsLONG timeStamp);

메시지가 전송된 시간을 설정합니다.

메시지를 전송하기 전에 이 메소드에 의해 설정된 시간 소인은 무시되며 메시지를 전송할 때 MessageProducer.send() 호출에 의해 대체됩니다. 그러나 이 메소드를 사용하면 수신한 메시지의 시간 소인을 변경할 수 있습니다.

매개변수:
timeStamp(입력)
메시지 전송 시간은 1970년 1월 1일 00:00:00 GMT 이후부터 밀리초 단위로 표시됩니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

setJMSType – JMSType 설정

인터페이스:
xmsVOID setJMSType(const String & type);

메시지의 유형을 설정합니다.

매개변수:
type(입력)
메시지의 유형을 캡슐화하는 String 오브젝트입니다.
리턴값:
Void
예외:
  • XMS_X_GENERAL_EXCEPTION

상속된 메소드


Reference topic

이용약관 | 피드백

Timestamp icon마지막 갱신 날짜: 3 Mar 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
이 Information Center는 Eclipse 기술 기반입니다. (http://www.eclipse.org 웹 사이트 참조)