From b43e8cd0f0858e78486752007c3640b70bf44c8d Mon Sep 17 00:00:00 2001 From: dimitri staessens Date: Thu, 13 Apr 2017 12:00:09 +0200 Subject: include, lib: Rename ap_init/ap_fini Fixes #35 --- doc/man/ap_init.3 | 67 ------------------------------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 doc/man/ap_init.3 (limited to 'doc/man/ap_init.3') diff --git a/doc/man/ap_init.3 b/doc/man/ap_init.3 deleted file mode 100644 index c5b93764..00000000 --- a/doc/man/ap_init.3 +++ /dev/null @@ -1,67 +0,0 @@ -.\" Ouroboros man pages (C) 2017 -.\" Dimitri Staessens -.\" Sander Vrijders - -.TH AP_INIT 3 2017-04-10 GNU "Ouroboros Programmer's Manual" - -.SH NAME - -ap_init, ap_fini \- initialize and finalize an application for using -Ouroboros - -.SH SYNOPSIS - -.B #include - -\fBint ap_init(char * \fIapn\fB);\fR - -\fBvoid ap_fini(void);\fR - -Compile and link with \fI-louroboros\fR. - -.SH DESCRIPTION - -The \fBap_init\fR() call initializes an application process instance -for using the Ouroboros IPC infrastructure. If the application is a -server or peer, a \fBchar * \fIapn\fR has to be provided indicating the -application process that this instance belongs to. This is usually -argv[0]. A client application may pass NULL. The \fBap_fini\fR() call -will release all resources allocated by \fBap_fini\fR(). - -\fBap_init\fR() and \fBap_fini\fR() should be called only once in the -application. - -.SH RETURN VALUE - -On success, \fBap_init\fR() returns 0. On failure, a negative value -indicating the error will be returned. The \fBap_fini\fR() function -has no return value. - -.SH ERRORS - -\fBap_init\fR() can return the following errors: - -.B -EIRMD -Failed to contact an IRMd instance. - -.B -ENOMEM -Insufficient system resources to intialize the application. - -.SH ATTRIBUTES - -For an explanation of the terms used in this section, see \fBattributes\fR(7). - -.TS -box, tab(&); -LB|LB|LB -L|L|L. -Interface & Attribute & Value -_ -\fBap_init\fR() & Thread safety & MT-Safe -_ -\fBap_fini\fR() & Thread safety & MT-Safe -.TE - -.SH COLOPHON -This page is part of the Ouroboros project, found at -https://bitbucket.org/ouroboros-rina/ouroboros -- cgit v1.2.3