|
OSMQ v2.0.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class used by client applications to write messages.
The Publisher dynamically locates and connects to a message broker. Once connected, the Publisher supports sending messages to a single recipient, or publishing anonymous topical messages to multiple subscribers.
Method Summary | |
void |
close()
Closes the message queues and halts message processing. |
void |
commit()
Transmits all messages that were published since the last call to commit() or rollback() . |
java.lang.String |
getBrokerName()
Returns the name of the remote message broker for this session. |
java.lang.String |
getClientID()
Returns the client identifier used by this session to communicate with the message broker. |
long |
getConnectionPublishedCount()
Returns the number of messages that have been published using this publisher's connection. |
ExceptionListener |
getExceptionListener()
Return the ExceptionListener that will be notified when there is an exception due to an inability to connect with the broker, or due to an I/O or communications failure. |
java.lang.String |
getHostName()
Returns the message broker's host address as a DNS host name or IP address. |
int |
getPortID()
Returns the port id that will be used to connect to the message broker. |
long |
getPublishedCount()
Returns the number of messages that have been published by this Publisher. |
boolean |
isAutoCommit()
Returns true if the publisher is in auto-commit mode. |
boolean |
isOpen()
Returns true if there is a connection to the message broker. |
boolean |
isThreaded()
|
void |
open()
Locates and connects to the remote message broker, and performs the necessary publisher authentication. |
void |
publish(Message ds)
Writes a message to the outbound queue. |
void |
rollback()
Discards all messages that were published since the last call to commit() or rollback() . |
void |
setAutoCommit(boolean autocommit)
Turns on or off the autocommitment of published messages to the message broker. |
void |
setBrokerName(java.lang.String broker)
Defines the named message broker that should be used for message processing (publishing). |
void |
setClientID(java.lang.String id)
Sets the identity of the application as a message originator (publisher) |
void |
setExceptionListener(ExceptionListener listener)
Sets an ExceptionListener that will be notified when there is an exception due to an inability to connect with the broker, or due to an I/O or communications failure. |
void |
setHostName(java.lang.String hostname)
Overrides the host name / IP address of the remote server; |
void |
setPortID(int port)
Overrides the port ID that the remote message server uses for connections. |
void |
setThreaded(boolean threaded)
|
Method Detail |
public void open() throws java.io.IOException
open
in interface ClientAdapter
java.io.IOException
public void setClientID(java.lang.String id)
setClientID
in interface ClientAdapter
id
- a unique name identifying the client application
to the message broker.public java.lang.String getClientID()
getClientID
in interface ClientAdapter
public void setBrokerName(java.lang.String broker)
setBrokerName
in interface ClientAdapter
public java.lang.String getBrokerName()
getBrokerName
in interface ClientAdapter
public void setPortID(int port)
NOTE: Normally this method should NOT be called by the client application.
setPortID
in interface ClientAdapter
public int getPortID()
getPortID
in interface ClientAdapter
setPortID(int)
public void setHostName(java.lang.String hostname)
NOTE: Normally this method should NOT be called by the client application.
setHostName
in interface ClientAdapter
public java.lang.String getHostName()
getHostName
in interface ClientAdapter
setHostName(String)
public void publish(Message ds) throws java.io.IOException, MessageException
java.io.IOException
MessageException
public boolean isOpen()
isOpen
in interface ClientAdapter
public void close()
close
in interface ClientAdapter
public long getPublishedCount()
public long getConnectionPublishedCount()
public void setExceptionListener(ExceptionListener listener)
setExceptionListener
in interface ClientAdapter
public ExceptionListener getExceptionListener()
getExceptionListener
in interface ClientAdapter
public void setAutoCommit(boolean autocommit) throws java.io.IOException
When autocommit is ON, each message that is published gets transmitted to the message broker for distribution.
When autocommit is OFF, the user must call commit()
to send published messages to the broker. Published messages that have not
been committed can be discarded by a call to the method rollback().
The commit() method transmits all messages that were published since the last call to commit() or rollback(). NOTE: The default mode is autocommit ON.
java.io.IOException
- an attempt to set autocommit to true when
there are messages that have been published but not commited
or rolled back.commit()
,
rollback()
public boolean isAutoCommit()
setAutoCommit(boolean)
public void commit() throws java.io.IOException, MessageException
Transmits all messages that were published since the last
call to commit()
or rollback()
.
This method is available when autocommit mode is OFF.
java.io.IOException
- autocommit mode is ON
MessageException
rollback()
,
setAutoCommit(boolean)
public void rollback() throws java.io.IOException
Discards all messages that were published since the last
call to commit()
or rollback()
.
This method is available when autocommit mode is OFF.
java.io.IOException
- autocommit mode is ONcommit()
,
setAutoCommit(boolean)
public void setThreaded(boolean threaded)
public boolean isThreaded()
|
(c) 2000 - 2003 MQue Systems All Rights Reserved |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |