Skip to content
Snippets Groups Projects
Commit 35a507fe authored by g0dil's avatar g0dil
Browse files

PPI: Add missing TargetDgramWriter doku

parent daa32d88
No related branches found
No related tags found
No related merge requests found
...@@ -65,19 +65,31 @@ namespace ppi { ...@@ -65,19 +65,31 @@ namespace ppi {
\param[in] packet Packet to write */ \param[in] packet Packet to write */
}; };
/** \brief Writer sending data with ClientSocketHandle::writeto()
This writer will send out data using ClientSocketHandle::writeto(). The target address can
be specified in the writer constructor and can be adjusted at any time.
If no target address is set, incoming data will be <em>silently dropped</em>.
*/
template <class HandleType> template <class HandleType>
class TargetDgramWriter class TargetDgramWriter
{ {
public: public:
typedef HandleType Handle; typedef HandleType Handle;
TargetDgramWriter(); TargetDgramWriter(); ///< Create TargetDgramWriter with unset target address
TargetDgramWriter(typename Handle::Address const & target); TargetDgramWriter(typename Handle::Address const & target);
///< Create TargetDgramWriter sending to \a target
typename Handle::Address target() const; typename Handle::Address target() const; ///< Get current target address
void target(typename Handle::Address const & target); void target(typename Handle::Address const & target); ///< Set target address
void operator()(Handle handle, Packet const & packet); void operator()(Handle handle, Packet const & packet); ///< Write \a packet to \a handle
/**< Write the complete \a packet as a datagram to \a
handle.
\param[in] handle Handle to write data to
\param[in] packet Packet to write */
private: private:
typename Handle::Address target_; typename Handle::Address target_;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment