PR ImportTCPSocket

NSPR
About NSPR
NSPR API Reference
NSPR Build Instruction
NSPR Release Process
Introduction to NSPR
NSPR Types
Threads
1. Threading Types and Constants
2. Threading Functions
Process Initialization
Locks
1. Lock Type
2. Lock Functions
Condition Variables
1. Condition Variable Type
2. Condition Variable Functions
Monitors
1. Monitor Type
2. Monitor Functions
Cached Monitors
1. Cached Monitor Functions
I/O Types
I/O Functions
Network Addresses
1. Network Address Types and Constants
2. Network Address Functions
Atomic Operations
Interval Timing
1. Interval Time Type and Constants
2. Interval Functions
Date and Time
Memory Management Operations
1. Memory Allocation Functions
2. Memory Allocation Macros
String Operations
Floating Point Number to String Conversion
Linked Lists
1. Linked List Types
  1. PRCList
2. Linked List Macros
Dynamic Library Linking
Process Management and Interprocess Communication
1. Process Management Types and Constants
  1. PRProcess
  2. PRProcessAttr
2. Process Management Functions
  1. Setting the Attributes of a New Process
  2. Creating and Managing Processes
Logging
Named Shared Memory
1. Shared Memory Protocol
2. Named Shared Memory Functions
Anonymous Shared Memory
1. Anonymous Memory Protocol
2. Anonymous Shared Memory Functions
IPC Semaphores
1. IPC Semaphore Functions
Thread Pools
1. Thread Pool Types
2. Thread Pool Functions
Random Number Generator
1. Random Number Generator Function
Hash Tables
1. Hash Tables and Type Constants
2. Hash Table Functions
NSPR Error Handling
Contribute
2. The MDN Project

Syntax

Parameters

Returns

Description

A native TCP socket osfd can be imported into NSPR with PR_ImportTCPSocket. The caller gives up control of the native TCP socket osfd and should use the PRFileDesc* returned by PR_ImportTCPSocket instead.

Although PR_ImportTCPSocket is a supported function, it is declared in "private/pprio.h" to stress the fact that this function depends on the internals of the NSPR implementation. The caller needs to understand what NSPR will do to the native file descriptor and make sure that NSPR can use the native file descriptor successfully.

For example, on POSIX systems, NSPR will put the native file descriptor (an int) in non-blocking mode by calling fcntl to set the O_NONBLOCK file status flag on the native file descriptor, and then NSPR will call socket functions such as recv, send, and poll on the native file descriptor. The caller must not do anything to the native file descriptor before the PR_ImportTCPSocket call that will prevent the native file descriptor from working in non-blocking mode.

Warning

In theory, code that uses PR_ImportTCPSocket may break when NSPR's implementation changes. In practice, this is unlikely to happen because NSPR's implementation has been stable for years and because of NSPR's strong commitment to backward compatibility. Using PR_ImportTCPSocket is much more convenient than writing an NSPR I/O layer that wraps your native TCP sockets. Of course, it is best if you just use PR_OpenTCPSocket or PR_NewTCPSocket. If you are not sure whether PR_ImportTCPSocket is right for you, please ask in the mozilla.dev.tech.nspr newsgroup.