# DatagramOutputFile¶

class DatagramOutputFile

Bases: DatagramSink

This class can be used to write a binary file that consists of an arbitrary header followed by a number of datagrams.

Inheritance diagram

DatagramOutputFile(void)
void close(void)

Closes the file. This is also implicitly done when the DatagramOutputFile destructs.

bool open(FileReference const *file)
bool open(Filename const &filename)
bool open(std::ostream &out, Filename const &filename = Filename())

Opens the indicated filename for writing. Returns true on success, false on failure.

Opens the indicated filename for writing. Returns true if successful, false on failure.

Starts writing to the indicated stream. Returns true on success, false on failure. The DatagramOutputFile does not take ownership of the stream; you are responsible for closing or deleting it when you are done.

bool write_header(std::string const &header)

Writes a sequence of bytes to the beginning of the datagram file. This may be called any number of times after the file has been opened and before the first datagram is written. It may not be called once the first datagram is written.