Base class for input rejecting filters. More...
#include <simple.h>
Inheritance diagram for InputRejecting< T >:
Classes | |
| struct | InputRejected |
Public Member Functions | |
INPUT | |
| size_t | Put2 (const byte *inString, size_t length, int messageEnd, bool blocking) |
| Input a byte array for processing. More... | |
SIGNALS | |
| bool | IsolatedFlush (bool hardFlush, bool blocking) |
| Flushes data buffered by this object, without signal propagation. More... | |
| bool | IsolatedMessageSeriesEnd (bool blocking) |
| Marks the end of a series of messages, without signal propagation. More... | |
| size_t | ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking) |
| Input multiple bytes for processing on a channel. More... | |
| bool | ChannelMessageSeriesEnd (const std::string &channel, int messageEnd, bool blocking) |
| Marks the end of a series of messages on a channel. More... | |
Detailed Description
template<class T>
class InputRejecting< T >
class InputRejecting< T >
Base class for input rejecting filters.
- Template Parameters
-
T the class or type
T should be a BufferedTransformation derived class
Member Function Documentation
◆ Put2()
template<class T >
|
inline |
Input a byte array for processing.
- Parameters
-
inString the byte array to process length the size of the string, in bytes messageEnd means how many filters to signal MessageEnd() to, including this one blocking specifies whether the object should block when processing input
- Exceptions
-
InputRejected
- Returns
- the number of bytes that remain to be processed (i.e., bytes not processed)
Internally, the default implementation throws InputRejected.
◆ IsolatedFlush()
template<class T >
|
inline |
◆ IsolatedMessageSeriesEnd()
template<class T >
|
inline |
◆ ChannelPut2()
template<class T >
|
inline |
Input multiple bytes for processing on a channel.
- Parameters
-
channel the channel to process the data. inString the byte buffer to process. length the size of the string, in bytes. messageEnd means how many filters to signal MessageEnd() to, including this one. blocking specifies whether the object should block when processing input.
- Returns
- the number of bytes that remain to be processed (i.e., bytes not processed)
◆ ChannelMessageSeriesEnd()
template<class T >
|
inline |
Marks the end of a series of messages on a channel.
- Parameters
-
channel the channel to signal the end of a series of messages messageEnd the number of attached transformations the ChannelMessageSeriesEnd() signal should be passed blocking specifies whether the object should block when processing input
- Returns
- true if the message was successful, false otherwise
Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.
propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.
- Note
- There should be a MessageEnd() immediately before MessageSeriesEnd().
The documentation for this class was generated from the following file:
