database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-30 11:03:19 +03:00
Code Activity

Rename PQsslAttributes() to PQsslAttributeNames(), and const-ify fully.

Browse Source 
Per discussion, the original name was a bit misleading, and
PQsslAttributeNames() seems more apropos.  It's not quite too late to
change this in 9.5, so let's change it while we can.

Also, make sure that the pointer array is const, not only the pointed-to
strings.

Minor documentation wordsmithing while at it.

Lars Kanis, slight adjustments by me
This commit is contained in:
Tom Lane
2015-11-07 16:13:49 -05:00
parent 44fc251536
commit ab994cc00e
6 changed files with 28 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/src/sgml/libpq.sgml
View File

@ -1873,7 +1873,7 @@ int PQsslInUse(const PGconn *conn);
</listitem>
</varlistentry>
<varlistentry id="libpq-pqsslAttribute">
<varlistentry id="libpq-pqsslattribute">
<term><function>PQsslAttribute</function><indexterm><primary>PQsslAttribute</></></term>
<listitem>
<para>
@ -1947,13 +1947,13 @@ const char *PQsslAttribute(const PGconn *conn, const char *attribute_name);
</listitem>
</varlistentry>
<varlistentry id="libpq-pqsslattributes">
<term><function>PQsslAttributes</function><indexterm><primary>PQsslAttributes</></></term>
<varlistentry id="libpq-pqsslattributenames">
<term><function>PQsslAttributeNames</function><indexterm><primary>PQsslAttributeNames</></></term>
<listitem>
<para>
Return an array of SSL attribute names available. The array is terminated by a NULL pointer.
<synopsis>
const char **PQsslAttributes(const PGconn *conn);
const char * const * PQsslAttributeNames(const PGconn *conn);
</synopsis>
</para>
</listitem>
@ -1963,15 +1963,15 @@ const char **PQsslAttributes(const PGconn *conn);
<term><function>PQsslStruct</function><indexterm><primary>PQsslStruct</></></term>
<listitem>
<para>
Return a pointer to an SSL-implementation specific object describing
Return a pointer to an SSL-implementation-specific object describing
the connection.
<synopsis>
void *PQsslStruct(const PGconn *conn, const char *struct_name);
</synopsis>
</para>
<para>
The structs available depends on the SSL implementation in use.
For OpenSSL, there is one struct, under the name "OpenSSL",
The struct(s) available depend on the SSL implementation in use.
For OpenSSL, there is one struct, available under the name "OpenSSL",
and it returns a pointer to the OpenSSL <literal>SSL</literal> struct.
To use this function, code along the following lines could be used:
<programlisting><![CDATA[

22
doc/src/sgml/release-9.5.sgml
View File

@ -608,18 +608,22 @@ FIXME: Add Andres
2015-02-03 [91fa7b4] Heikki..: Add API functions to libpq to interrogate SSL ..
-->
<para>
Add <application>libpq</> function <link
linkend="libpq-pqsslAttribute"><function>PQsslAttribute()</></>
that returns <acronym>SSL</> information (Heikki Linnakangas)
Add <application>libpq</> functions to return <acronym>SSL</>
information in an implementation-independent way (Heikki Linnakangas)
</para>
<para>
While <link linkend="libpq-pqgetssl"><function>PQgetssl()</></>
can still be used to call <productname>OpenSSL</>
functions, <function>PQsslAttribute()</> returns <acronym>SSL</>
information in an <acronym>SSL</>-implementation-independent way.
(Future versions of libpq might support other <acronym>SSL</>
implementations.)
While <link linkend="libpq-pqgetssl"><function>PQgetssl()</></> can
still be used to call <productname>OpenSSL</> functions, it is now
considered deprecated because future versions
of <application>libpq</> might support other <acronym>SSL</>
implementations. When possible, use the new
functions <link
linkend="libpq-pqsslattribute"><function>PQsslAttribute()</></>, <link
linkend="libpq-pqsslattributenames"><function>PQsslAttributeNames()</></>,
and <link linkend="libpq-pqsslinuse"><function>PQsslInUse()</></>
to obtain <acronym>SSL</> information in
an <acronym>SSL</>-implementation-independent way.
</para>
</listitem>