Conventions

SmartSockets follows a number of conventions for the naming and syntax of functions. These conventions are intended to make the syntax of functions more predictable and consistent.

All SmartSockets global functions, macros, typedefs, structures, unions, enums, and defines begin with the letter T.

All SmartSockets global functions use mixed case for their names. After the uppercase T follows a two or three letter code indicating which library they are from, such as TipcMsgCreate or TutExit. They never contain underscore (_) characters.

All SmartSockets macros, typedefs, enums, and defines start with T_ and are in uppercase. These names use underscores for compound words. Examples are T_IPC_CONN, and T_TYPE_NUMERIC.

All interprocess communication functions start with Tipc.

All utility functions start with Tut.

All callback functions have the string Cb in their names; for example, TipcSrvCbCreate.

All traversal functions have the string Traverse in their names; for example, TutHashTraverse.

All lookup functions have the string Lookup in their name; for example, TipcConnProcessCbLookup.

All access functions have the strings Get, if retrieving, or Set, if storing, in their names; for example, TipcGetCurrentType and TipcSetLbMode.

Functions that create or destroy things (objects, callbacks) have the strings Create or Destroy in their names; for example, TipcSrvDestroy and TipcMsgCreate.