Changeset 0acfd1e for libwandio/wandio.h


Ignore:
Timestamp:
05/14/13 11:48:23 (9 years ago)
Author:
Shane Alcock <salcock@…>
Branches:
4.0.1-hotfixes, cachetimestamps, develop, dpdk-ndag, etsilive, getfragoff, help, libtrace4, master, ndag_format, pfring, rc-4.0.1, rc-4.0.2, rc-4.0.3, rc-4.0.4, ringdecrementfix, ringperformance, ringtimestampfixes
Children:
d57ae6f
Parents:
460855d
Message:
  • Added a wandio_create_uncompressed function to the libwandio API. It's there for people who are running into problems with the compression autodetection incorrectly thinking their uncompressed files are actually compressed. Hopefully, this should be very very rare, but it can't hurt to have it right?
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libwandio/wandio.h

    rbd37451 r0acfd1e  
    233233 * @return A pointer to a new libtrace IO reader, or NULL if an error occurs
    234234 *
    235  * This function will attempt to detect the compression format used for the
    236  * given file (if any), provided that libtrace was built with the appropriate
    237  * libraries.
     235 * The compression format will be determined automatically by peeking at the
     236 * first few bytes of the file and comparing them against known compression
     237 * file header formats. If no formats match, the file will be assumed to be
     238 * uncompressed.
    238239 */
    239240io_t *wandio_create(const char *filename);
     241
     242/** Creates a new libtrace IO reader and opens the provided file for reading.
     243 *
     244 * @param filename      The name of the file to open
     245 * @return A pointer to a new libtrace IO reader, or NULL if an error occurs
     246 *
     247 * Unlike wandio_create, this function will always assume the file is
     248 * uncompressed and therefore not run the compression autodetection algorithm.
     249 *
     250 * Use this function if you are only working with uncompressed files and are
     251 * running into problems with the start of your files resembling compression
     252 * format headers. Otherwise, you should really be using wandio_create.
     253 */
     254io_t *wandio_create_uncompressed(const char *filename);
    240255
    241256/** Returns the current offset of the read pointer for a libtrace IO reader.
Note: See TracChangeset for help on using the changeset viewer.