index.rst (5971B)
1 NSPR API Reference 2 ================== 3 4 .. toctree:: 5 :maxdepth: 2 6 7 Introduction to NSPR 8 -------------------- 9 10 - :ref:`NSPR_Naming_Conventions` 11 - :ref:`NSPR_Threads` 12 13 - :ref:`Thread_Scheduling` 14 15 - :ref:`Setting_Thread_Priorities` 16 - :ref:`Preempting_Threads` 17 - :ref:`Interrupting_Threads` 18 19 - :ref:`NSPR_Thread_Synchronization` 20 21 - :ref:`Locks_and_Monitors` 22 - :ref:`Condition_Variables` 23 24 - :ref:`NSPR_Sample_Code` 25 26 NSPR Types 27 ---------- 28 29 - :ref:`Calling_Convention_Types` 30 - :ref:`Algebraic_Types` 31 32 - :ref:`8-.2C_16-.2C_and_32-bit_Integer_Types` 33 34 - :ref:`Signed_Integers` 35 - :ref:`Unsigned_Integers` 36 37 - :ref:`64-bit_Integer_Types` 38 - :ref:`Floating-Point_Number_Type` 39 - :ref:`Native_OS_Integer_Types` 40 41 - :ref:`Miscellaneous_Types` 42 43 - :ref:`Size_Type` 44 - :ref:`Pointer_Difference_Types` 45 - :ref:`Boolean_Types` 46 - :ref:`Status_Type_for_Return_Values` 47 48 Threads 49 ------- 50 51 - :ref:`Threading_Types_and_Constants` 52 - :ref:`Threading_Functions` 53 54 - :ref:`Creating.2C_Joining.2C_and_Identifying_Threads` 55 - :ref:`Controlling_Thread_Priorities` 56 - :ref:`Controlling_Per-Thread_Private_Data` 57 - :ref:`Interrupting_and_Yielding` 58 - :ref:`Setting_Global_Thread_Concurrency` 59 - :ref:`Getting_a_Thread.27s_Scope` 60 61 Process Initialization 62 ---------------------- 63 64 - :ref:`Identity_and_Versioning` 65 66 - :ref:`Name_and_Version_Constants` 67 68 - :ref:`Initialization_and_Cleanup` 69 - :ref:`Module_Initialization` 70 71 Locks 72 ----- 73 74 - :ref:`Lock_Type` 75 - :ref:`Lock_Functions` 76 77 Condition_Variables 78 ------------------- 79 80 - :ref:`Condition_Variable_Type` 81 - :ref:`Condition_Variable_Functions` 82 83 Monitors 84 -------- 85 86 - :ref:`Monitor_Type` 87 - :ref:`Monitor_Functions` 88 89 Cached Monitors 90 --------------- 91 92 - :ref:`Cached_Monitors_Functions` 93 94 I/O Types 95 --------- 96 97 - :ref:`Directory_Type` 98 - :ref:`File_Descriptor_Types` 99 - :ref:`File_Info_Types` 100 - :ref:`Network_Address_Types` 101 - :ref:`Types_Used_with_Socket_Options_Functions` 102 - :ref:`Type_Used_with_Memory-Mapped_I.2FO` 103 - :ref:`Offset_Interpretation_for_Seek_Functions` 104 105 I/O Functions 106 ------------- 107 108 - :ref:`Functions_that_Operate_on_Pathnames` 109 - :ref:`Functions_that_Act_on_File_Descriptors` 110 - :ref:`Directory_I.2FO_Functions` 111 - :ref:`Socket_Manipulation_Functions` 112 - :ref:`Converting_Between_Host_and_Network_Addresses` 113 - :ref:`Memory-Mapped_I.2FO_Functions` 114 - :ref:`Anonymous_Pipe_Function` 115 - :ref:`Polling_Functions` 116 - :ref:`Pollable_Events` 117 - :ref:`Manipulating_Layers` 118 119 Network Addresses 120 ----------------- 121 122 - :ref:`Network_Address_Types_and_Constants` 123 - :ref:`Network_Address_Functions` 124 125 Atomic Operations 126 ----------------- 127 128 - :ref:`PR_AtomicIncrement` 129 - :ref:`PR_AtomicDecrement` 130 - :ref:`PR_AtomicSet` 131 132 Interval Timing 133 --------------- 134 135 - :ref:`Interval_Time_Type_and_Constants` 136 - :ref:`Interval_Functions` 137 138 Date and Time 139 ------------- 140 141 - :ref:`Types_and_Constants` 142 - :ref:`Time_Parameter_Callback_Functions` 143 - :ref:`Functions` 144 145 Memory_Management Operations 146 ---------------------------- 147 148 - :ref:`Memory_Allocation_Functions` 149 - :ref:`Memory_Allocation_Macros` 150 151 String Operations 152 ----------------- 153 154 - :ref:`PL_strlen` 155 - :ref:`PL_strcpy` 156 - :ref:`PL_strdup` 157 - :ref:`PL_strfree` 158 159 Floating Point Number to String Conversion 160 ------------------------------------------ 161 162 - :ref:`PR_strtod` 163 - :ref:`PR_dtoa` 164 - :ref:`PR_cnvtf` 165 166 Linked Lists 167 ------------ 168 169 - :ref:`Linked_List_Types` 170 171 - :ref:`PRCList` 172 173 - :ref:`Linked_List_Macros` 174 175 - :ref:`PR_INIT_CLIST` 176 - :ref:`PR_INIT_STATIC_CLIST` 177 - :ref:`PR_APPEND_LINK` 178 - :ref:`PR_INSERT_LINK` 179 - :ref:`PR_NEXT_LINK` 180 - :ref:`PR_PREV_LINK` 181 - :ref:`PR_REMOVE_LINK` 182 - :ref:`PR_REMOVE_AND_INIT_LINK` 183 - :ref:`PR_INSERT_BEFORE` 184 - :ref:`PR_INSERT_AFTER` 185 186 Dynamic Library Linking 187 ----------------------- 188 189 - :ref:`Library_Linking_Types` 190 191 - :ref:`PRLibrary` 192 - :ref:`PRStaticLinkTable` 193 194 - :ref:`Library_Linking_Functions` 195 196 - :ref:`PR_SetLibraryPath` 197 - :ref:`PR_GetLibraryPath` 198 - :ref:`PR_GetLibraryName` 199 - :ref:`PR_FreeLibraryName` 200 - :ref:`PR_LoadLibrary` 201 - :ref:`PR_UnloadLibrary` 202 - :ref:`PR_FindSymbol` 203 - :ref:`PR_FindSymbolAndLibrary` 204 - :ref:`Finding_Symbols_Defined_in_the_Main_Executable_Program` 205 206 - :ref:`Platform_Notes` 207 208 - :ref:`Dynamic_Library_Search_Path` 209 - :ref:`Exporting_Symbols_from_the_Main_Executable_Program` 210 211 Process Management and Interprocess Communication 212 ------------------------------------------------- 213 214 - :ref:`Process_Management_Types_and_Constants` 215 216 - :ref:`PRProcess` 217 - :ref:`PRProcessAttr` 218 219 - :ref:`Process_Management_Functions` 220 221 - :ref:`Setting_the_Attributes_of_a_New_Process` 222 - :ref:`Creating_and_Managing_Processes` 223 224 Logging 225 ------- 226 227 - :ref:`Conditional_Compilation_and_Execution` 228 - :ref:`Log_Types_and_Variables` 229 230 - :ref:`PRLogModuleInfo` 231 - :ref:`PRLogModuleLevel` 232 - :ref:`NSPR_LOG_MODULES` 233 - :ref:`NSPR_LOG_FILE` 234 235 - :ref:`Logging_Functions_and_Macros` 236 237 - :ref:`PR_NewLogModule` 238 - :ref:`PR_SetLogFile` 239 - :ref:`PR_SetLogBuffering` 240 - :ref:`PR_LogPrint` 241 - :ref:`PR_LogFlush` 242 - :ref:`PR_LOG_TEST` 243 - :ref:`PR_LOG` 244 - :ref:`PR_Assert` 245 - :ref:`PR_ASSERT` 246 - :ref:`PR_NOT_REACHED` 247 248 - :ref:`Use_Example` 249 250 Named Shared Memory 251 ------------------- 252 253 - :ref:`Shared_Memory_Protocol` 254 - :ref:`Named_Shared_Memory_Functions` 255 256 Anonymous Shared_Memory 257 ----------------------- 258 259 - :ref:`Anonymous_Memory_Protocol` 260 - :ref:`Anonymous_Shared_Memory_Functions` 261 262 IPC Semaphores 263 -------------- 264 265 - :ref:`IPC_Semaphore_Functions` 266 267 Thread Pools 268 ------------ 269 270 - :ref:`Thread_Pool_Types` 271 - :ref:`Thread_Pool_Functions` 272 273 Random Number Generator 274 ----------------------- 275 276 - :ref:`Random_Number_Generator_Function` 277 278 Hash Tables 279 ----------- 280 281 - :ref:`Hash_Table_Types_and_Constants` 282 - :ref:`Hash_Table_Functions` 283 284 NSPR Error Handling 285 ------------------- 286 287 - :ref:`Error_Type` 288 - :ref:`Error_Functions` 289 - :ref:`Error_Codes`