diff options
author | Arthur de Jong <arthur@arthurdejong.org> | 2007-10-31 23:12:41 +0100 |
---|---|---|
committer | Arthur de Jong <arthur@arthurdejong.org> | 2007-10-31 23:12:41 +0100 |
commit | 9c9650a553aaa08cc09d4161be1e45ae887f624f (patch) | |
tree | 8b8f1c86a5d27c785d728ce9ef645ee7587af98c /nslcd.h | |
parent | 60fe991f7cdfdda93e64a743896facfb7ed9ad10 (diff) |
improve comments about protocol, also describing the final NSLCD_RESULT_NOTFOUND
git-svn-id: http://arthurdejong.org/svn/nss-pam-ldapd/nss-ldapd@475 ef36b2f9-881f-0410-afb5-c4e39611909c
Diffstat (limited to 'nslcd.h')
-rw-r--r-- | nslcd.h | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -42,23 +42,26 @@ [result value(s)] If a response would return multiple values (e.g. for NSLCD_ACTION_*_ALL functions) each return value will be preceded by a NSLCD_RESULT_* value. + The last value will be marked by a result value other than + NSLCD_RESULT_SUCCESS. Note that the server may including a trailing + NSLCD_RESULT_NOTFOUND after all the results. These are the available data types: INT32 - 32-bit integer value TYPE - a typed field that is transferred using sizeof() STRING - a string length (32bit) followed by the string value (not null-terminted) the string itself is assumed to be UTF-8 - STRINGLIST - a 32-bit number noting the number of strings followed by the - strings one at a time + STRINGLIST - a 32-bit number noting the number of strings followed by + the strings one at a time Compound datatypes (such as PASSWD) are defined below as a combination of - the above types. They are defined as macros so they can be expanded to code - later on. + the above types. They are defined as macros so they can be expanded to + code later on. - The protocol is described in this generic fashion (instead of just - transferring the allocated memory) because pointers will not be valid - between transfers and this also makes the server independant of the NSS - implementation. + The protocol uses host-byte order for all types (except where the normal + value in-memory is already in network-byte order like with some + addresses). This simple protocol makes it easy to support diffenrent NSS + implementations. */ /* used for transferring alias information */ |