]> git.proxmox.com Git - mirror_edk2.git/blobdiff - StdLib/EfiSocketLib/Init.c
Vlv2TbltDevicePkg/PlatformFlashAccessLib: Fix IA32 build issues
[mirror_edk2.git] / StdLib / EfiSocketLib / Init.c
index f444acc74267054f76f88fa538dca8b2fb793d33..88d2065c2116e7ecb08c999ff1b4a2c8ef87b313 100644 (file)
 /**\r
   EFI Socket Library Constructor\r
 \r
-  @retval EFI_SUCCESS       The initialization was successful\r
+  This routine supports an implementation dependent constructor\r
+  depending upon whether the library is linked to a socket\r
+  application or the SocketDxe driver.  The following modules\r
+  declare the redirection for the constructor in ::mpfnEslConstructor:\r
+  <ul>\r
+    <li>StdLib/EfiSocketLib/UseSocketLib.c - Application links against EfiSocketLib</li>\r
+    <li>StdLib/SocketDxe/EntryUnload.c - SocketDxe links against EfiSocketLib</li>\r
+  </ul>\r
+\r
+  The EfiSocketLib.inf file lists ::EslConstructor as the CONSTRUCTOR\r
+  in the [Defines] section.  As a result, this routine is called by\r
+  the ProcessLibraryConstructorList routine of the AutoGen.c module\r
+  in the Build directory associated with the socket application or\r
+  the SocketDxe driver.\r
+\r
+  @retval EFI_SUCCESS       The socket layer initialization was successful\r
 \r
  **/\r
 EFI_STATUS\r
@@ -54,7 +69,22 @@ EslConstructor (
 /**\r
   EFI Socket Library Destructor\r
 \r
-  @retval EFI_SUCCESS       The shutdown was successful\r
+  This routine supports an implementation dependent destructor\r
+  depending upon whether the library is linked to a socket\r
+  application or the SocketDxe driver.  The following modules\r
+  declare the redirection for the destructor in ::mpfnEslDestructor:\r
+  <ul>\r
+    <li>StdLib/EfiSocketLib/UseSocketLib.c - Application links against EfiSocketLib</li>\r
+    <li>StdLib/SocketDxe/EntryUnload.c - SocketDxe links against EfiSocketLib</li>\r
+  </ul>\r
+\r
+  The EfiSocketLib.inf file lists ::EslDestructor as the DESTRUCTOR\r
+  in the [Defines] section.  As a result, this routine is called by\r
+  the ProcessLibraryDestructorList routine of the AutoGen.c module\r
+  in the Build directory associated with the socket application or\r
+  the SocketDxe driver.\r
+\r
+  @retval EFI_SUCCESS       The socket layer shutdown was successful\r
 \r
  **/\r
 EFI_STATUS\r