FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OME Internal I/O Classes

Classes

class  OMEfileDescriptor
 Filesystem-specific I/O descriptor. More...
 
struct  OMEioVector
 Equivalent of iov structure. More...
 
class  OMEioDescriptor
 Base class for open files and sockets. More...
 
class  OMEsocketDescriptor
 Networking-specific I/O descriptor. More...
 
class  OMEunixDomainDescriptor
 Unix file-domain socket-specific I/O descriptor. More...
 

Typedefs

typedef OMEioDescriptor *(* OMEopenSchemeFP) (const OMEstring &url, int *errRet)
 

Functions

int OMEregisterIOscheme (const OMEstring &schemePrefix, OMEopenSchemeFP func)
 Register support for new I/O transport scheme. More...
 
int OMEregisterIOscheme (const char *schemePrefix, OMEopenSchemeFP func)
 Register support for new I/O transport scheme. More...
 
OMEioDescriptorOMEopenURL (const OMEstring &url, int *errRet=nullptr)
 Open an I/O descriptor based on an URL. More...
 
void OMEregisterStandardSocketSchemes ()
 Register standard socket-related I/O transport schemes. More...
 

Detailed Description

Typedef Documentation

◆ OMEopenSchemeFP

typedef OMEioDescriptor*(* OMEopenSchemeFP) (const OMEstring &url, int *errRet)

Function Documentation

◆ OMEopenURL()

OMEioDescriptor* OMEopenURL ( const OMEstring url,
int *  errCode 
)

Open an I/O descriptor based on an URL.

Parameters
urlholds the URL identifying the resource to be opened.
errCodeis a pointer to an integer which can hold an extended error return code. If this is not of interest, a null (0) value will be passed.
Returns
A pointer to an OMEioDescriptor object that accesses the resource is returned upon success. If it is not possible to open the resource, a null pointer will be returned.

References OMEstring::length().

Referenced by OMEconnection::establishConnection(), and openURL().

◆ OMEregisterIOscheme() [1/2]

int OMEregisterIOscheme ( const char *  prefix,
OMEopenSchemeFP  func 
)

Register support for new I/O transport scheme.

Parameters
prefixis a null-terminated C string that identifies the name of the I/O scheme.
funcis the address of the function to be called when a resource associated with the schemePrefix is to be opened.
See also
OMEregisterIOscheme(const OMEstring &, OMEopenSchemeFP)

References OMEregisterIOscheme().

◆ OMEregisterIOscheme() [2/2]

int OMEregisterIOscheme ( const OMEstring prefix,
OMEopenSchemeFP  func 
)

Register support for new I/O transport scheme.

Parameters
prefixis reference to an OMEstring which holds the name of the I/O scheme.
funcis the address of the function to be called when a resource associated with the schemePrefix is to be opened.

The FARGOS/VISTA Object Management Environment can be extended with support for new I/O transport schemes. Scheme names are terminated with a colon (":"). Some common core schemes are "tcp4:", "udp4:", "tcp6:", "udp6:", "file:", "spx:", "ipx:".

References OME_CRITICAL_SECTION_MISCELLANEOUS, and OMEstartCriticalSection().

Referenced by INIT_DECLARE_file(), OMEregisterIOscheme(), and OMEregisterStandardSocketSchemes().

◆ OMEregisterStandardSocketSchemes()

void OMEregisterStandardSocketSchemes ( )

Register standard socket-related I/O transport schemes.

References OMEregisterIOscheme(), and OMEsocketDescriptor::openSocketScheme().

Referenced by INIT_DECLARE_socket().

Generated: Tue Jul 28 2020 16:03:26
Support Information