IRodsConnection Struct Reference

This is a wrapper which hides the internals of the code and objects needed to access an iRODS system. More...

#include <irods_connection.h>

Public Member Functions
struct IRodsConnection *	CreateIRodsConnectionFromUserDetails (const User *user_p)
	Create a connection to a local iRODS server. More...
struct IRodsConnection *	CreateIRodsConnection (UserAuthentication *auth_p)
	Create a connection to a local iRODS server. More...
void	FreeIRodsConnection (struct IRodsConnection *connection_p)
	Close a connection to an iRODS server. More...

Data Fields
rcComm_t *	ic_connection_p
	The underlying connection to and iRODS server. More...

Detailed Description

This is a wrapper which hides the internals of the code and objects needed to access an iRODS system.

This means that you can interact with the iRODS server more easily.

Member Function Documentation

CreateIRodsConnectionFromUserDetails()

struct IRodsConnection * CreateIRodsConnectionFromUserDetails

(

const User *

user_p

)

Create a connection to a local iRODS server.

Parameters

user_p

The UserDetails to get the required credentials from to create this IRodsConnection.

Returns

The connection to the iRODS server or NULL upon error.

CreateIRodsConnection()

struct IRodsConnection * CreateIRodsConnection

(

UserAuthentication *

auth_p

)

Create a connection to a local iRODS server.

Parameters

auth_p

The UserAuthentication to use to get the required credentials from to create this IRodsConnection.

Returns

The connection to the iRODS server or NULL upon error.

FreeIRodsConnection()

void FreeIRodsConnection

(

struct IRodsConnection *

connection_p

)

Close a connection to an iRODS server.

Parameters

connection_p

The connection to close.

Field Documentation

ic_connection_p

rcComm_t* ic_connection_p

The underlying connection to and iRODS server.

---

The documentation for this struct was generated from the following files:

• irods_connection.h
• connect.h