/usr/lib/emboss/include/ensdatabaseconnection.h is in emboss-lib 6.6.0+dfsg-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | /* @include ensdatabaseconnection *********************************************
**
** Ensembl Database Connection functions
**
** @author Copyright (C) 1999 Ensembl Developers
** @author Copyright (C) 2006 Michael K. Schuster
** @version $Revision: 1.16 $
** @modified $Date: 2012/02/04 10:30:23 $ by $Author: mks $
** @modified $Date: 2012/02/04 10:30:23 $ by $Author: mks $
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
** Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with this library; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA 02110-1301, USA.
**
******************************************************************************/
#ifndef ENSDATABASECONNECTION_H
#define ENSDATABASECONNECTION_H
/* ========================================================================= */
/* ============================= include files ============================= */
/* ========================================================================= */
#include "ajax.h"
AJ_BEGIN_DECLS
/* ========================================================================= */
/* =============================== constants =============================== */
/* ========================================================================= */
/* ========================================================================= */
/* ============================== public data ============================== */
/* ========================================================================= */
/* @data EnsPDatabaseconnection ***********************************************
**
** Ensembl Database Connection.
**
** Holds information to connect to a particular SQL database on a
** relational database management system (RDBMS) instance.
**
** @alias EnsSDatabaseconnection
** @alias EnsODatabaseconnection
**
** @attr Sqlconnection [AjPSqlconnection] AJAX SQL Connection
** @attr Username [AjPStr] User name
** @attr Password [AjPStr] Password
** @attr Hostname [AjPStr] Host name or IP address
** @attr Hostport [AjPStr] Host TCP/IP port
** @attr Socketfile [AjPStr] UNIX socket file
** @attr Databasename [AjPStr] SQL database name
** @attr Autodisconnect [AjBool] Automatic disconnections
** @attr Sqlconnectionclient [AjESqlconnectionClient] AJAX SQL
** Connection client
** @attr Timeout [ajuint] Timeout in seconds for closing idle, non-interactive
** connections
** @attr Use [ajuint] Use counter
**
** @@
******************************************************************************/
typedef struct EnsSDatabaseconnection
{
AjPSqlconnection Sqlconnection;
AjPStr Username;
AjPStr Password;
AjPStr Hostname;
AjPStr Hostport;
AjPStr Socketfile;
AjPStr Databasename;
AjBool Autodisconnect;
AjESqlconnectionClient Sqlconnectionclient;
ajuint Timeout;
ajuint Use;
} EnsODatabaseconnection;
#define EnsPDatabaseconnection EnsODatabaseconnection*
/* ========================================================================= */
/* =========================== public functions ============================ */
/* ========================================================================= */
/*
** Prototype definitions
*/
EnsPDatabaseconnection ensDatabaseconnectionNewCpy(
EnsPDatabaseconnection dbc,
AjPStr database);
EnsPDatabaseconnection ensDatabaseconnectionNewIni(
AjESqlconnectionClient client,
AjPStr user,
AjPStr password,
AjPStr host,
AjPStr port,
AjPStr socketfile,
AjPStr database,
ajuint dbctimeout);
EnsPDatabaseconnection ensDatabaseconnectionNewRef(EnsPDatabaseconnection dbc);
EnsPDatabaseconnection ensDatabaseconnectionNewUrl(const AjPStr url);
void ensDatabaseconnectionDel(EnsPDatabaseconnection *Pdbc);
AjBool ensDatabaseconnectionGetAutodisconnect(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetDatabasename(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetHostname(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetHostport(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetPassword(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetSocketfile(
const EnsPDatabaseconnection dbc);
AjPSqlconnection ensDatabaseconnectionGetSqlconnection(
const EnsPDatabaseconnection dbc);
AjESqlconnectionClient ensDatabaseconnectionGetSqlconnectionclient(
const EnsPDatabaseconnection dbc);
ajuint ensDatabaseconnectionGetTimeout(
const EnsPDatabaseconnection dbc);
AjPStr ensDatabaseconnectionGetUsername(
const EnsPDatabaseconnection dbc);
AjBool ensDatabaseconnectionSetAutodisconnect(
EnsPDatabaseconnection dbc,
AjBool autodisconnect);
AjBool ensDatabaseconnectionTrace(const EnsPDatabaseconnection dbc,
ajuint level);
AjBool ensDatabaseconnectionIsConnected(const EnsPDatabaseconnection dbc);
AjBool ensDatabaseconnectionMatch(const EnsPDatabaseconnection dbc1,
const EnsPDatabaseconnection dbc2);
AjBool ensDatabaseconnectionConnect(EnsPDatabaseconnection dbc);
AjBool ensDatabaseconnectionDisconnect(EnsPDatabaseconnection dbc);
AjBool ensDatabaseconnectionEscapeC(EnsPDatabaseconnection dbc,
char **Ptxt,
const AjPStr str);
AjBool ensDatabaseconnectionEscapeS(EnsPDatabaseconnection dbc,
AjPStr *Pstr,
const AjPStr str);
AjBool ensDatabaseconnectionSqlstatementDel(
EnsPDatabaseconnection dbc,
AjPSqlstatement *Psqls);
AjPSqlstatement ensDatabaseconnectionSqlstatementNew(
EnsPDatabaseconnection dbc,
const AjPStr statement);
AjBool ensDatabaseconnectionFetchUrl(const EnsPDatabaseconnection dbc,
AjPStr *Purl);
/*
** End of prototype definitions
*/
AJ_END_DECLS
#endif /* !ENSDATABASECONNECTION_H */
|