dnxTSPI.h File Reference

Types and definitions for low-level transport service providers. More...

#include "dnxTransport.h"

Go to the source code of this file.

Data Structures
struct	iDnxChannel_
	The generic Transport Service Provider Interface (TSPI) structure. More...
Typedefs
typedef struct iDnxChannel_	iDnxChannel
	The generic Transport Service Provider Interface (TSPI) structure.
Functions
int	dnxTSPInit (int(**ptxAlloc)(char *url, iDnxChannel **icpp))
	Transport Service Provider initialization function.
void	dnxTSPExit (void)
	Transport Service Provider clean-up function.

---

Detailed Description

Types and definitions for low-level transport service providers.

Transport service providers must implement the transport service provider interface (TSPI), and then populate the iDnxChannel structure, so that the Transport interface has access to its I/O methods.

Author:

John Calcote (jcalcote@users.sourceforge.net)

Attention:

Please submit patches to http://dnx.sourceforge.net

Definition in file dnxTSPI.h.

---

Typedef Documentation

typedef struct iDnxChannel_ iDnxChannel

The generic Transport Service Provider Interface (TSPI) structure.

---

Function Documentation

void dnxTSPExit

(

void

)

Transport Service Provider clean-up function.

Deinitializes the exporting TSPI module.

int dnxTSPInit

(

int(**)(char *url, iDnxChannel **icpp)

ptxAlloc

)

Transport Service Provider initialization function.

Initializes the exporting TSPI module and returns a connection constructor method that may be called with a URL whose scheme presumably matches the transport.

URL scheme-matching is a higher level function; by the time the URL reaches the connection constructor, it is assumed that the scheme already matches the type of connection being constructed. The constructor merely parses the scheme-specific portion, which should contain binding information, eg., host name and port number for IP-based transports.

The connection constructor returned in ptxAlloc accepts a URL (from which it parses scheme-specific connection parameters) and returns a pointer to a newly allocated (but unconnected) connection object. It returns zero on success, or a non-zero error value.

Parameters:

[out]

ptxAlloc

- the address of storage for returning a pointer to the transport-specific connection constructor.

Returns:

Zero on success, or a non-zero error value.