CreateReceiverLink Method

Creates a new receiver link with the given name on the specified session.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int CreateReceiverLink(const char* lpszSessionName, const char* lpszName, const char* lpszSource);

Unicode (Windows)
INT CreateReceiverLink(LPCWSTR lpszSessionName, LPCWSTR lpszName, LPCWSTR lpszSource);

- (void)createReceiverLink:(NSString*)sessionName :(NSString*)name :(NSString*)source;

#define MID_AMQP_CREATERECEIVERLINK 6

IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_AMQP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the Link* properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Source may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.

Receiver links can operate in one of two receive modes: automatic, where the class will work to ensure that messages are received as soon as they are available; and fetch-based, where the class will only "fetch" a new message when explicitly instructed to.

The ReceiveMode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

amqp.ReceiveMode = AmqpReceiveModes.rmFetch;
amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)