Skip to content

Commit

Permalink
Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
maxim2266 committed Sep 9, 2015
1 parent c098d5c commit b0f6bf2
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion doc/doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ Instead, the library provides a number of conversion functions for retrieving th
value of a tag in different formats, including a string, an integer, a double, etc.
The same functions can also act as format validators.

The parser takes raw bytes as input and provides an API for extracting messages one-by-one.
Each message gets extracted and parsed (steps 1 and 2 above) and returned to the user
as an efficient `tag->value` mapping. All processing happens in the same thread of execution
to avoid any synchronisation overhead, especially when integrating the library into
an existing software.

### Data representation
All the definitions of the data types described below are located in the
file `include/fix.h`.
Expand Down Expand Up @@ -433,7 +439,7 @@ void process_new_order_single(parser_context* context, fix_group* root)
}
```
where the clean-up function may look like the following:
where the clean-up function is trivial and provided here just for the sake of completeness:
```c
void free_new_order_single(new_order_single* order)
Expand Down

0 comments on commit b0f6bf2

Please sign in to comment.