A base class for communication interfaces, conforming to the IComm protocol.
More...
#include <AComm.h>
|
int | maxPacketSize |
| The maximum packet size for communication.
|
|
NSString * | descriptor |
| The descriptor for the communication interface.
|
|
int | bytesAvailable |
| The number of bytes available to read.
|
|
BOOL | isConnected |
| A flag indicating whether the connection is established.
|
|
NSString * | descriptor |
| The descriptor for the communication interface.
|
|
int | bytesAvailable |
| The number of bytes available to read.
|
|
BOOL | isConnected |
| A flag indicating whether the connection is established.
|
|
A base class for communication interfaces, conforming to the IComm protocol.
◆ close
Closes the communication interface.
Reimplemented from <IComm>.
Reimplemented in TcpComm.
◆ open
Opens the communication interface.
Reimplemented from <IComm>.
Reimplemented in TcpComm.
◆ read
Reads data from the communication interface.
- Returns
- The data read from the interface.
Reimplemented from <IComm>.
Reimplemented in TcpComm.
◆ readToBinaryWriter:
- (void) readToBinaryWriter: |
|
(NSOutputStream *) | binDataIn |
|
Reads data into a binary writer (output stream).
- Parameters
-
binDataIn | The output stream to write the data into. |
Reimplemented from <IComm>.
◆ waitForDataWithTimeout:
- (void) waitForDataWithTimeout: |
|
(NSTimeInterval) | msTimeOut |
|
Waits for data to be available within a specified timeout.
- Parameters
-
msTimeOut | The timeout interval in milliseconds. |
Reimplemented from <IComm>.
◆ write:
- (void) write: |
|
(NSData *) | dataOut |
|
Writes data to the communication interface.
- Parameters
-
dataOut | The data to write to the interface. |
Reimplemented from <IComm>.
Reimplemented in TcpComm.
◆ writeAndWaitForResponse:responseStartTimeOut:responseEndTimeOut:completionToken:
- (NSData *) writeAndWaitForResponse: |
|
(NSData *) | text |
responseStartTimeOut: |
|
(NSTimeInterval) | responseStartTimeOut |
responseEndTimeOut: |
|
(NSTimeInterval) | responseEndTimeOut |
completionToken: |
|
(NSString *) | completionToken |
Writes data to the communication interface and waits for a response.
- Parameters
-
text | The data to write to the interface. |
responseStartTimeOut | The timeout interval for the start of the response. |
responseEndTimeOut | The timeout interval for the end of the response. |
completionToken | A token indicating the completion of the response. |
- Returns
- The data received in response from the interface.
Reimplemented from <IComm>.
Reimplemented in TcpComm.
◆ writeAndWaitForResponseToBinaryWriter:fromBinaryReader:responseStartTimeout:responseEndTimeout:completionToken:
- (void) writeAndWaitForResponseToBinaryWriter: |
|
(NSOutputStream *) | binDataIn |
fromBinaryReader: |
|
(NSInputStream *) | binDataOut |
responseStartTimeout: |
|
(int) | responseStartTimeOut |
responseEndTimeout: |
|
(int) | responseEndTimeOut |
completionToken: |
|
(NSString *) | completionToken |
Writes data to the communication interface and waits for a response, using binary streams.
- Parameters
-
binDataIn | The output stream to write the data into. |
binDataOut | The input stream to read the response from. |
responseStartTimeOut | The timeout interval for the start of the response. |
responseEndTimeOut | The timeout interval for the end of the response. |
completionToken | A token indicating the completion of the response. |
Reimplemented from <IComm>.
◆ writeFromBinaryReader:
- (void) writeFromBinaryReader: |
|
(NSInputStream *) | binReader |
|
Writes data from a binary reader (input stream) to the communication interface.
- Parameters
-
binReader | The input stream to read the data from. |
Reimplemented from <IComm>.
◆ bytesAvailable
The number of bytes available to read.
◆ descriptor
The descriptor for the communication interface.
◆ isConnected
A flag indicating whether the connection is established.
◆ maxPacketSize
The maximum packet size for communication.
The documentation for this class was generated from the following file:
- /Users/realbuber/Documents/Project/sdk_json_Objective-C/AutoIdSDK/Comm/AComm.h