src/lib/AbstractParser.h
branchv_0
changeset 14 02725d301010
parent 13 d5e2cb9e31f1
equal deleted inserted replaced
13:d5e2cb9e31f1 14:02725d301010
   104 	 * @param length size of the buffer
   104 	 * @param length size of the buffer
   105 	 */
   105 	 */
   106 	void peek(uint8_t* buffer, const size_t length);
   106 	void peek(uint8_t* buffer, const size_t length);
   107 
   107 
   108 	/**
   108 	/**
       
   109 	 * @return total number of bytes that were successfully read
       
   110 	 */
       
   111 	size_t getBytesRead();
       
   112 
       
   113 	/**
   109 	 * Reads input from buffers using read(), parses data and usually emits the result (e.g. to a handler/listener).
   114 	 * Reads input from buffers using read(), parses data and usually emits the result (e.g. to a handler/listener).
   110 	 * Is specific for particular format/parser.
   115 	 * Is specific for particular format/parser.
   111 	 * 
   116 	 * 
   112 	 * This method is called at least once at the end of the stream (with whole stream content in read buffers).
   117 	 * This method is called at least once at the end of the stream (with whole stream content in read buffers).
   113 	 * Usually it is called more often, by default: after each write (with just already received data part in read buffers).
   118 	 * Usually it is called more often, by default: after each write (with just already received data part in read buffers).