nl::Inet::Platform::InetLayer

Summary

Functions
`DidInit(Inet::InetLayer aLayer, void aContext, INET_ERROR anError)`	`NL_DLL_EXPORT void` This is a platform-specific InetLayer post-initialization hook.
`DidShutdown(Inet::InetLayer aLayer, void aContext, INET_ERROR anError)`	`NL_DLL_EXPORT void` This is a platform-specific InetLayer post-shutdown hook.
`WillInit(Inet::InetLayer aLayer, void aContext)`	`NL_DLL_EXPORT INET_ERROR` This is a platform-specific InetLayer pre-initialization hook.
`WillShutdown(Inet::InetLayer aLayer, void aContext)`	`NL_DLL_EXPORT INET_ERROR` This is a platform-specific InetLayer pre-shutdown hook.

Functions

DidInit

NL_DLL_EXPORT void DidInit(
  Inet::InetLayer *aLayer,
  void *aContext,
  INET_ERROR anError
)

This is a platform-specific InetLayer post-initialization hook.

This may be overridden by assserting the preprocessor definition, INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS.

Details

Parameters

`[in,out] aLayer`	A pointer to the InetLayer instance being initialized.
`[in,out] aContext`	Platform-specific context data passed to the layer initialization method, ::Init.
`[in] anError`	The overall status being returned via the InetLayer ::Init method.

DidShutdown

NL_DLL_EXPORT void DidShutdown(
  Inet::InetLayer *aLayer,
  void *aContext,
  INET_ERROR anError
)

This is a platform-specific InetLayer post-shutdown hook.

This may be overridden by assserting the preprocessor definition, INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS.

Details

Parameters

`[in,out] aLayer`	A pointer to the InetLayer instance being shutdown.
`[in,out] aContext`	Platform-specific context data passed to the layer initialization method, ::Init.
`[in] anError`	The overall status being returned via the InetLayer ::Shutdown method.

WillInit

NL_DLL_EXPORT INET_ERROR WillInit(
  Inet::InetLayer *aLayer,
  void *aContext
)

This is a platform-specific InetLayer pre-initialization hook.

This may be overridden by assserting the preprocessor definition, INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS.

Details

Parameters

`[in,out] aLayer`	A pointer to the InetLayer instance being initialized.
`[in,out] aContext`	Platform-specific context data passed to the layer initialization method, ::Init.

Returns

INET_NO_ERROR on success; otherwise, a specific error indicating the reason for initialization failure. Returning non-successful status will abort initialization.

WillShutdown

NL_DLL_EXPORT INET_ERROR WillShutdown(
  Inet::InetLayer *aLayer,
  void *aContext
)

This is a platform-specific InetLayer pre-shutdown hook.

This may be overridden by assserting the preprocessor definition, INET_CONFIG_WILL_OVERRIDE_PLATFORM_XTOR_FUNCS.

Details

Parameters

`[in,out] aLayer`	A pointer to the InetLayer instance being shutdown.
`[in,out] aContext`	Platform-specific context data passed to the layer initialization method, ::Init.

Returns

INET_NO_ERROR on success; otherwise, a specific error indicating the reason for shutdown failure. Returning non-successful status will abort shutdown.