|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.jniwrapper.win32.dde.DdeClient
public class DdeClient
This class provides functionality for establishing connection with a DDE service.
Constructor Summary | |
---|---|
DdeClient(java.lang.String service,
java.lang.String topic)
Creates a DDE client of the specified service and topic. |
Method Summary | |
---|---|
void |
abandonTransaction(long transactionID)
Abandons the specified asynchronous transaction and releases all transaction resources, so that the event handler will not receive notification when the transaction is processed. |
void |
connect()
Establishes connection with the service. |
void |
disconnect()
Disconnects the client from the service. |
void |
execute(java.lang.String command,
long timeout)
Executes the specified command and waits for a confirmation response from the service. |
long |
executeAsync(java.lang.String command)
Asynchronously executes the specified command. |
byte[] |
get(DdeItem item,
long timeout)
Makes a synchronous request to the service for data that corresponds to the specified item. |
long |
getAsync(DdeItem item)
Makes an asynchronous request to the service for data that corresponds to the specified item. |
java.lang.String |
getServiceName()
Returns the service name which the client is connected to. |
java.lang.String |
getTopicName()
Returns the topic name which the client is connected to. |
void |
removeEventHandler()
Removes the handler of the client events. |
void |
send(DdeItem item,
byte[] data,
long timeout)
Sends data to the service and waits for a confirmation response. |
long |
sendAsync(DdeItem item,
byte[] data)
Asynchronously sends data to the service. |
void |
setEventHandler(DdeClientEventHandler eventHandler)
Specifies the handler of the client events. |
void |
startAdviseLoop(DdeItem item,
boolean sendData,
boolean sync,
long timeout)
Begins an advise loop and waits for confirmation response from the service. |
long |
startAdviseLoopAsync(DdeItem item,
boolean sendData,
boolean sync)
Asynchronously begins an advise loop. |
void |
stopAdviseLoop(DdeItem item,
long timeout)
Stops an advise loop and waits for a confirmation response from the service. |
long |
stopAdviseLoopAsync(DdeItem item)
Asynchronously stops an advise loop. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DdeClient(java.lang.String service, java.lang.String topic)
service
- is the name of the service of interest. It can be the basic name
(for example, MyService) or an instance-specific service name (for example, "MyService(0X0046025E)".topic
- is the name of the service's topic.Method Detail |
---|
public void connect() throws DdeException
DdeException
public void disconnect() throws DdeException
DdeException
public long getAsync(DdeItem item) throws DdeException
item
- specifies an item name and required data format.
DdeException
DdeItem
public byte[] get(DdeItem item, long timeout) throws DdeException
item
- specifies an item name and required data format.timeout
- is the maximum amount of time, in milliseconds, that the client waits
for the server response.
DdeException
public long sendAsync(DdeItem item, byte[] data) throws DdeException
item
- specifies an item name and data format.data
- is the data to be sent.
DdeException
DdeItem
public void send(DdeItem item, byte[] data, long timeout) throws DdeException
item
- specifies an item name and data format.data
- is the data to be sent.timeout
- is the maximum amount of time, in milliseconds, that the client waits
for the server's response.
DdeException
DdeItem
public long executeAsync(java.lang.String command) throws DdeException
command
- specifies the command to be executed.
DdeException
public void execute(java.lang.String command, long timeout) throws DdeException
command
- specifies the command to be executed.timeout
- is the maximum amount of time, in milliseconds, that the client waits
for the server's response.
DdeException
public long startAdviseLoopAsync(DdeItem item, boolean sendData, boolean sync) throws DdeException
item
- specifies an item name and required data format.sendData
- if true
, the service will send the changed data with notification,
otherwise, the service will notify the client without sending the data.sync
- if true
, the service will not send the next notification until
the previous one is processed by the client.
DdeException
public void startAdviseLoop(DdeItem item, boolean sendData, boolean sync, long timeout) throws DdeException
item
- specifies an item name and required data format.sendData
- if true
, the service will send the changed data with notification,
otherwise, the service will notify the client without sending the data.sync
- if true
, the service will not send the next notification until
the previous one is processed by the client.timeout
- is the maximum amount of time, in milliseconds, that the client waits
for the server's response.
DdeException
public long stopAdviseLoopAsync(DdeItem item) throws DdeException
item
- specifies an item name.
DdeException
public void stopAdviseLoop(DdeItem item, long timeout) throws DdeException
item
- specifies an item name.timeout
- is the maximum amount of time, in milliseconds, that the client waits
for the server's response.
DdeException
public void abandonTransaction(long transactionID) throws DdeException
transactionID
- is a transaction identifier.
DdeException
public java.lang.String getServiceName()
public java.lang.String getTopicName()
public void setEventHandler(DdeClientEventHandler eventHandler)
eventHandler
- DdeClientEventHandler
public void removeEventHandler()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |