Interface ILargeMessage
Purpose
The ILargeMessage interface provides APIs with the ability to transfer large files and the ability to check the status and/or to resume a file transfer.
Method Summary
Retrieves the status of the message. 'Status' refers to the number of bytes transferred, the number of bytes left to be transferred, and so on.
Sets the status listener for the message. This API asynchronously detects the status of a message being transferred.
Retrieves the status listener for the message.
Saves the contents of the message in the file specified.
Resumes an incomplete transfer. This API resumes the process of saving the contents of a message in the file specified.
Resumes an incomplete transfer. This API resumes the process of sending a message. It is used when this process could not be completed due to either an internal error or due to a problem originating at the client's side.
Cancels the transfer process of all messages for transferring this large message. Canceling a transfer removes the 'resume' information related to that transfer. A transfer once canceled, cannot be resumed.
Cancels the transfer process of the message belonging to the consumer identified by the consumer ID. Every consumer has a unique consumer ID assigned by the producer when the transfer starts. The API can be used by the sender and by the receiver. Canceling a transfer removes the 'resume' information related to that transfer. A transfer, once canceled, cannot be resumed.
Temporarily suspends all message transfers transferring this large message. Suspending a transfer only stops the thread that is performing the message transfer. No 'resume' related information is deleted. A transfer that is suspended can be resumed using resumeSend() and resumeSaveTo() APIs.
Temporarily suspends the message transfer specified by the consumer ID. Suspending a transfer only stops the thread that is performing the message transfer. No 'resume' related information is deleted so a suspended transfer can be resumed using resumeSend () and resumeSaveTo() APIs.
Sets the fragment size of the message.
Retrieves the fragment size of the message.
Sets the window size for the message. Window size indicates the length of the time interval, after which the receiver sends an acknowledgment for message fragments received.
Retrieves the window size of the message.
Sets the time duration for which sender waits for large message requests sent by the receiver.
Retrieves the time duration for which the sender waits for the receiver's request.
Sets the time duration for which the receiver waits for a message fragment sent by the sender.
Retrieves the time duration for which the receiver waits to receive a message fragment from the sender.
Interface ILMConnection
Purpose
ILMConnection provides APIs to retrieve messages that could not be entirely sent or received.
Method Summary
Sets the User directory within which the resume file is saved
Retrieves the user directory in which the resume file is saved
Retrieves the enumeration of ILargeMessages that could not be sent in entirety.
Retrieves the enumeration of ILargeMessages that fail to be transferred in their entirety.
Indicates whether a connection has any ongoing transfers. This API is used by the application to close the connection depending upon whether or not the connection has transfers in progress.
Class LMTransferStatus
Purpose
Class LMTransferStatus provides the status of a message transfer. The 'status' of a message transfer refers to the number of bytes transferred, the number of bytes to be transferred, the last fragment of bytes transferred successfully, the percentage of progress of the transfer, and so on.
Constants Summary
Indicates that the transfer has not yet started.
Indicates that the transfer is currently in progress.
Indicates that the transfer is complete.
Indicates that an error occurred during the transfer.
Method Summary
Returns the number of bytes transferred.
Returns the number of bytes left to be transferred.
Returns the fragment number of the last fragment sent successfully.
Returns the percentage of completion of the message transfer.
Returns the status of the message transfer. The status of a message can be any one of the statuses mentioned above.
Returns a Boolean value, indicative of whether or not the transfer was completed successfully.
Returns the reference of a large message whose status is displayed by LMTransferStatus.
Interface LMStatusListener
Purpose
The LMStatusListener interface is used to detect, asynchronously, the status of a message being transferred.
Method Summary
Method callback is invoked in the event of a change in message transfer status, or in the event of an error that occurs during message transfer.
Class FioranoLMErrorCodes
Purpose
Class FioranoLMErrorCodes defines the error codes and error messages used by LMS.
This exception is encountered when the source file specified in the message is invalid.
This exception is encountered when CSP/Durable connections are enabled when using LMS.
This exception is encountered when a request for a large message is not received from any consumer in the specified time duration.
This exception is encountered when an error occurs in the process of decoding LMS properties
This exception is encountered when the producer does not receive any acknowledgement of receipt of message fragments from the consumer in the specified time duration.
This exception is encountered when the producer is unable to send the message fragment to the consumer.
This exception is encountered when the producer is unable to process the acknowledgement received from the consumer.
This exception is encountered when an error occurs on the producer's side during a message transfer.
This exception is encountered when an error occurs while initializing the message transfer.
This exception is encountered when an error occurs while processing the message request received from the consumer.
This exception is encountered when the producer is unable to send message availability notification to the consumer. The 'availability' message is a message that is sent by the producer to the consumer if there are any unfinished messages to resume.
This exception is encountered when an error occurs while reading data from the source file.
This exception is encountered when an error occurs while receiving message fragments sent by the producer.
This exception is encountered when the consumer is not able to receive the message fragment within the period of the specified 'timeout'.
This exception is encountered when the consumer is not able to the send an acknowledgement regarding a message fragment to the producer.
This exception is encountered when the producer is not able to resume a message transfer.
This exception is encountered when the target file specified by the consumer is not valid.
This exception is encountered when an error occurs while saving the target file due to the unavailability of free disk space.
This exception is encountered when the consumer is not able to resume the message transfer.
This exception is encountered when an error occurs while writing data onto the target file.
This exception is encountered when saveTo() API is invoked for a message which is not considered a large message.
This exception is encountered when cancellation of a transfer is invoked for a message that is not considered a large message.