Understanding MprInfo Functions and Information Headers
The following functions require that the caller pass an information structure or header as one of the parameters.
Administration function | Configuration function |
---|---|
No administration function | MprConfigTransportCreate |
MprAdminTransportSetInfo | MprConfigTransportSetInfo |
MprAdminInterfaceTransportSetInfo | MprConfigInterfaceTransportSetInfo |
MprAdminInterfaceTransportAdd | MprConfigInterfaceTransportAdd |
Similarly, the following functions return information headers.
Administration function | Configuration function |
---|---|
MprAdminTransportGetInfo | MprConfigTransportGetInfo |
MprAdminInterfaceTransportGetInfo | MprConfigInterfaceTransportGetInfo |
For the transport functions, the information header contains global information for the transport. For the client (InterfaceTransport) functions, the header contains information specific to the client (for example, OSPF) being administered.
The information headers and their contents should be manipulated only by using the MprInfo functions. Developers should not attempt to manipulate the contents of the information headers directly.
The interface-only functions such as MprAdminInterfaceSetInfo do not require the use of MprInfo functions. The information that is passed and returned with these functions is always in the form of an MPR_INTERFACE structure.