Serial library for MTS Socket Modem Arduino Shield devices from Multi-Tech Systems
Dependents: mDot_AT_firmware mtsas mtsas MTDOT-EVB-LinkCheck-AL ... more
Diff: MTSBufferedIO.h
- Revision:
- 13:643ad09fc0e0
- Parent:
- 11:4afbbafcd6b3
--- a/MTSBufferedIO.h Thu Mar 23 16:15:14 2017 -0500 +++ b/MTSBufferedIO.h Fri Sep 11 11:26:01 2020 -0500 @@ -43,7 +43,7 @@ * the buffer is full. */ int write(const char* data, int length, unsigned int timeoutMillis); - + /** This method enables bulk writes to the Tx or write buffer. This method * blocks until all the bytes are written. * @@ -52,7 +52,7 @@ * @returns the number of bytes written to the buffer, which should be * equal to the length parameter since this method blocks. */ - int write(const char* data, int length); + int write(const char* data, int length); /** This method enables bulk writes to the Tx or write buffer. This method * blocks until all the bytes are written. @@ -72,7 +72,7 @@ * expired. */ int write(char data, unsigned int timeoutMillis); - + /** This method writes a single byte as a char to the Tx or write buffer. * This method blocks until the byte is written. * @@ -97,7 +97,7 @@ * @returns the total number of bytes that were read. */ int read(char* data, int length, unsigned int timeoutMillis); - + /** This method enables bulk reads from the Rx or read buffer. This method * blocks until the amount of data requested is received. * @@ -117,7 +117,7 @@ * @returns 1 if byte is read or 0 if no byte is available. */ int read(char& data, unsigned int timeoutMillis); - + /** This method reads a single byte from the Rx or read buffer. * This method blocks until the single byte is read. * @@ -167,13 +167,13 @@ /** This abstract method should be used by the deriving class to transfer * data from the internal write buffer (txBuffer) to the physical interface. - * Note that this function is called everytime new data is written to the + * Note that this function is called every time new data is written to the * txBuffer through one of the write calls. */ virtual void handleWrite() = 0; /** This abstract method should be used by the deriving class to transfer - * data from the physical interface ot the internal read buffer (rxBuffer). + * data from the physical interface to the internal read buffer (rxBuffer). * Note that this function is never called in this class and typically should * be called as part of a receive data interrupt routine. */ @@ -181,7 +181,7 @@ protected: MTSCircularBuffer txBuffer; // Internal write or transmit circular buffer - MTSCircularBuffer rxBuffer; // Internal read or receieve circular buffer + MTSCircularBuffer rxBuffer; // Internal read or receive circular buffer }; }