Skip to content

Commit

Permalink
simple document in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cloudwu committed Nov 30, 2011
1 parent ee04a0d commit 5dd78f3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,28 @@

PBC is a google protocol buffers library for C without code generation.

Working in progress.
## Message API

## Todo
You can use *wmessage* for encoding , and *rmessage* for decoding.

* extension support
See test_addressbook.c for detail.

## Pattern API

If you need higher performance , you can use pbc_pattern_xxx api .

See test_pattern.c for detail.

pattern api is faster, and less memory used, and you can access data from native C struct .

## Extension

PBC support extension with a simple way . It add prefix to the extension field name.

## Service

Not supported

## Enum

With message API , you can use both string and integer as the enum type , and with pattern api it must be integer.
2 changes: 0 additions & 2 deletions pbc.h
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ void pbc_array_push_integer(pbc_array array, uint32_t low, uint32_t hi);
void pbc_array_push_slice(pbc_array array, struct pbc_slice *);
void pbc_array_push_real(pbc_array array, double v);

// todo : pattern api

struct pbc_pattern * pbc_pattern_new(struct pbc_env * , const char * message, const char *format, ...);
void pbc_pattern_delete(struct pbc_pattern *);

Expand Down

0 comments on commit 5dd78f3

Please sign in to comment.