Common calls in a communications API
Inspired by several generic interfaces in the Unix/Linux world such as the socket API, and event-driven programming, I have been using the following calls (functions or methods, and event notifications) in my communications APIs
May be replaced by the constructor of a class. Creates resources that are held for the lifetime of this object. A corresponding call
destroymay also be implemented for deterministic finalization of resources.
configurationprovides whatever configuration information is required for connection. It may also be passed to
initor obtained by some other means.
callbackis invoked when connection is established. If implementing a server API, use
onConnectfor notification of incoming connection.
Event notification when an incoming connection is established.
Finalizes communication, and calls callback when done. In a server API
disconnectmay receive an additional parameter indicating which connection to disconnect from.
Event notification when a disconnection happens and
disconnecthas not been invoked.
Event notification when incoming data is received.
Called when data needs to be sent. If data is an array of bytes, it may receive additional parameters such as start
length. It may additionally receive a callback that is called when data is sent out (if the API buffers data).
Event notification when an
errorneeds to be communicated.
Event notifications can be implemented differently in various languages. I have used callback function in C, delegates in .NET, event listeners (observers) in Java, Blocks in Objective C, and EventEmitter in Node.js.