Grassroots Infrastructure
The Grassroots Infrastructure is a suite of computing tools to help users and developers use scientific data infrastructure that can easily be interconnected.
connect.h
Go to the documentation of this file.
1 /*
2 ** Copyright 2014-2016 The Earlham Institute
3 **
4 ** Licensed under the Apache License, Version 2.0 (the "License");
5 ** you may not use this file except in compliance with the License.
6 ** You may obtain a copy of the License at
7 **
8 ** http://www.apache.org/licenses/LICENSE-2.0
9 **
10 ** Unless required by applicable law or agreed to in writing, software
11 ** distributed under the License is distributed on an "AS IS" BASIS,
12 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 ** See the License for the specific language governing permissions and
14 ** limitations under the License.
15 */
16 
21 #ifndef IRODS_CONNECT_H
22 #define IRODS_CONNECT_H
23 
24 
25 #include "jansson.h"
26 #include "irods_util_library.h"
27 #include "user_details.h"
28 
29 /* forward declaration */
30 struct IRodsConnection;
31 
32 #ifdef __cplusplus
33 extern "C"
34 {
35 #endif
36 
37 
47 
48 
57 IRODS_UTIL_API struct IRodsConnection *CreateIRodsConnection (UserAuthentication *auth_p);
58 
59 
66 IRODS_UTIL_API void FreeIRodsConnection (struct IRodsConnection *connection_p);
67 
68 
69 
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif /* #ifndef IRODS_CONNECT_H */
IRodsConnection::CreateIRodsConnectionFromUserDetails
struct IRodsConnection * CreateIRodsConnectionFromUserDetails(const User *user_p)
Create a connection to a local iRODS server.
IRodsConnection
This is a wrapper which hides the internals of the code and objects needed to access an iRODS system.
Definition: irods_connection.h:42
IRODS_UTIL_API
#define IRODS_UTIL_API
Definition: irods_util_library.h:46
irods_util_library.h
IRodsConnection::CreateIRodsConnection
struct IRodsConnection * CreateIRodsConnection(UserAuthentication *auth_p)
Create a connection to a local iRODS server.
User
A datatype to store user credentials.
Definition: user_details.h:40
user_details.h
IRodsConnection::FreeIRodsConnection
void FreeIRodsConnection(struct IRodsConnection *connection_p)
Close a connection to an iRODS server.