summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/man/CMakeLists.txt4
-rw-r--r--doc/man/ap_fini.31
-rw-r--r--doc/man/ap_init.367
-rw-r--r--doc/man/flow_alloc.33
-rw-r--r--doc/man/ouroboros_fini.31
-rw-r--r--doc/man/ouroboros_init.369
-rw-r--r--include/ouroboros/dev.h4
-rw-r--r--src/ipcpd/ipcp.c8
-rw-r--r--src/irmd/main.c2
-rw-r--r--src/lib/dev.c4
-rw-r--r--src/tools/cbr/cbr.c6
-rw-r--r--src/tools/echo/echo.c6
-rw-r--r--src/tools/echo/echo_server.c2
-rw-r--r--src/tools/operf/operf.c6
-rw-r--r--src/tools/oping/oping.c6
15 files changed, 96 insertions, 93 deletions
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
index c864d756..f0ce5df4 100644
--- a/doc/man/CMakeLists.txt
+++ b/doc/man/CMakeLists.txt
@@ -1,7 +1,7 @@
set(MAN_NAMES
# Add man page sources here
- ap_init.3
- ap_fini.3
+ ouroboros_init.3
+ ouroboros_fini.3
flow_accept.3
flow_alloc.3
flow_dealloc.3
diff --git a/doc/man/ap_fini.3 b/doc/man/ap_fini.3
deleted file mode 100644
index 4aaa723b..00000000
--- a/doc/man/ap_fini.3
+++ /dev/null
@@ -1 +0,0 @@
-.so 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 <dimitri.staessens@ugent.be>
-.\" Sander Vrijders <sander.vrijders@ugent.be>
-
-.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 <ouroboros/dev.h>
-
-\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
diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3
index 84dd5f57..dd0fe7ea 100644
--- a/doc/man/flow_alloc.3
+++ b/doc/man/flow_alloc.3
@@ -109,7 +109,8 @@ _
.SH SEE ALSO
-.BR ap_init "(3), " ap_fini "(3), " flow_read "(3), " flow_write (3)
+.BR ouroboros_init "(3), " ouroboros_fini "(3), " \
+flow_read "(3), " flow_write (3)
.SH COLOPHON
This page is part of the Ouroboros project, found at
diff --git a/doc/man/ouroboros_fini.3 b/doc/man/ouroboros_fini.3
new file mode 100644
index 00000000..d525d287
--- /dev/null
+++ b/doc/man/ouroboros_fini.3
@@ -0,0 +1 @@
+.so ouroboros_init.3
diff --git a/doc/man/ouroboros_init.3 b/doc/man/ouroboros_init.3
new file mode 100644
index 00000000..c74bea5e
--- /dev/null
+++ b/doc/man/ouroboros_init.3
@@ -0,0 +1,69 @@
+.\" Ouroboros man pages (C) 2017
+.\" Dimitri Staessens <dimitri.staessens@ugent.be>
+.\" Sander Vrijders <sander.vrijders@ugent.be>
+
+.TH OUROBOROS_INIT 3 2017-04-10 GNU "Ouroboros Programmer's Manual"
+
+.SH NAME
+
+ouroboros_init, ouroboros_fini \- initialize and finalize an
+application for using Ouroboros
+
+.SH SYNOPSIS
+
+.B #include <ouroboros/dev.h>
+
+\fBint ouroboros_init(char * \fIapn\fB);\fR
+
+\fBvoid ouroboros_fini(void);\fR
+
+Compile and link with \fI-louroboros\fR.
+
+.SH DESCRIPTION
+
+The \fBouroboros_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
+\fBouroboros_fini\fR() call will release all resources allocated by
+\fBouroboros_fini\fR().
+
+\fBouroboros_init\fR() and \fBouroboros_fini\fR() should be called
+only once in the application.
+
+.SH RETURN VALUE
+
+On success, \fBouroboros_init\fR() returns 0. On failure, a negative
+value indicating the error will be returned. The
+\fBouroboros_fini\fR() function has no return value.
+
+.SH ERRORS
+
+\fBouroboros_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
+_
+\fBouroboros_init\fR() & Thread safety & MT-Safe
+_
+\fBouroboros_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
diff --git a/include/ouroboros/dev.h b/include/ouroboros/dev.h
index 31c681db..396f2ae3 100644
--- a/include/ouroboros/dev.h
+++ b/include/ouroboros/dev.h
@@ -30,9 +30,9 @@
#define OUROBOROS_DEV_H
/* These calls should be removed once we write the ouroboros OS. */
-int ap_init(const char * ap_name);
+int ouroboros_init(const char * ap_name);
-void ap_fini(void);
+void ouroboros_fini(void);
/* Returns flow descriptor, qs updates to supplied QoS. */
int flow_alloc(const char * dst_name,
diff --git a/src/ipcpd/ipcp.c b/src/ipcpd/ipcp.c
index 795ce42c..47c951f1 100644
--- a/src/ipcpd/ipcp.c
+++ b/src/ipcpd/ipcp.c
@@ -476,12 +476,12 @@ int ipcp_init(int argc,
log_init(log);
if (type == IPCP_NORMAL) {
- if (ap_init(argv[0])) {
+ if (ouroboros_init(argv[0])) {
log_err("Failed to init normal IPCPI.");
return -1;
}
} else {
- if (ap_init(NULL)) {
+ if (ouroboros_init(NULL)) {
log_err("Failed to init shim IPCPI.");
return -1;
}
@@ -600,7 +600,7 @@ int ipcp_init(int argc,
fail_sock_path:
free(ipcpi.threadpool);
fail_thr:
- ap_fini();
+ ouroboros_fini();
return ret;
}
@@ -732,7 +732,7 @@ void ipcp_fini()
log_fini();
- ap_fini();
+ ouroboros_fini();
log_info("IPCP %d out.", getpid());
}
diff --git a/src/irmd/main.c b/src/irmd/main.c
index d24c0ba1..bdc03ef8 100644
--- a/src/irmd/main.c
+++ b/src/irmd/main.c
@@ -931,7 +931,7 @@ static int flow_accept(pid_t api,
e = api_table_get(&irmd.api_table, api);
if (e == NULL) {
- /* Can only happen if server called ap_init(NULL); */
+ /* Can only happen if server called ouroboros_init(NULL); */
pthread_rwlock_unlock(&irmd.reg_lock);
log_err("Unknown instance %d calling accept.", api);
return -EINVAL;
diff --git a/src/lib/dev.c b/src/lib/dev.c
index d68fb471..757f26a8 100644
--- a/src/lib/dev.c
+++ b/src/lib/dev.c
@@ -245,7 +245,7 @@ static void reset_flow(int fd)
init_flow(fd);
}
-int ap_init(const char * ap_name)
+int ouroboros_init(const char * ap_name)
{
int i = 0;
@@ -335,7 +335,7 @@ int ap_init(const char * ap_name)
return 0;
}
-void ap_fini()
+void ouroboros_fini()
{
int i = 0;
diff --git a/src/tools/cbr/cbr.c b/src/tools/cbr/cbr.c
index cd29c9ad..597ae8a6 100644
--- a/src/tools/cbr/cbr.c
+++ b/src/tools/cbr/cbr.c
@@ -129,14 +129,14 @@ int main(int argc, char ** argv)
}
if (server) {
- if (ap_init(argv_dup[0]) < 0) {
+ if (ouroboros_init(argv_dup[0]) < 0) {
printf("Failed to init.\n");
exit(EXIT_FAILURE);
}
ret = server_main();
} else {
- if (ap_init(NULL) < 0) {
+ if (ouroboros_init(NULL) < 0) {
printf("Failed to init.\n");
exit(EXIT_FAILURE);
}
@@ -150,7 +150,7 @@ int main(int argc, char ** argv)
ret = client_main(s_apn, duration, size, rate, flood, sleep);
}
- ap_fini();
+ ouroboros_fini();
return ret;
}
diff --git a/src/tools/echo/echo.c b/src/tools/echo/echo.c
index 051a16c3..b68e8c02 100644
--- a/src/tools/echo/echo.c
+++ b/src/tools/echo/echo.c
@@ -59,20 +59,20 @@ int main(int argc, char ** argv)
}
if (server) {
- if (ap_init(argv_dup[0])) {
+ if (ouroboros_init(argv_dup[0])) {
printf("Failed to init AP.\n");
return -1;
}
ret = server_main();
} else {
- if (ap_init(NULL)) {
+ if (ouroboros_init(NULL)) {
printf("Failed to init AP.\n");
return -1;
}
ret = client_main();
}
- ap_fini();
+ ouroboros_fini();
return ret;
}
diff --git a/src/tools/echo/echo_server.c b/src/tools/echo/echo_server.c
index 771155f4..22175a65 100644
--- a/src/tools/echo/echo_server.c
+++ b/src/tools/echo/echo_server.c
@@ -31,7 +31,7 @@ void shutdown_server(int signo)
{
(void) signo;
- ap_fini();
+ ouroboros_fini();
exit(EXIT_SUCCESS);
}
diff --git a/src/tools/operf/operf.c b/src/tools/operf/operf.c
index 7935d12c..5e7f2f37 100644
--- a/src/tools/operf/operf.c
+++ b/src/tools/operf/operf.c
@@ -140,14 +140,14 @@ int main(int argc, char ** argv)
}
if (serv) {
- if (ap_init(argv_dup[0])) {
+ if (ouroboros_init(argv_dup[0])) {
printf("Failed to init AP.\n");
exit(EXIT_FAILURE);
}
ret = server_main();
} else {
- if (ap_init(NULL)) {
+ if (ouroboros_init(NULL)) {
printf("Failed to init AP.\n");
exit(EXIT_FAILURE);
}
@@ -171,7 +171,7 @@ int main(int argc, char ** argv)
ret = client_main();
}
- ap_fini();
+ ouroboros_fini();
if (ret < 0)
exit(EXIT_FAILURE);
diff --git a/src/tools/oping/oping.c b/src/tools/oping/oping.c
index 7c9c108c..a88e06e5 100644
--- a/src/tools/oping/oping.c
+++ b/src/tools/oping/oping.c
@@ -139,14 +139,14 @@ int main(int argc, char ** argv)
}
if (serv) {
- if (ap_init(argv_dup[0])) {
+ if (ouroboros_init(argv_dup[0])) {
printf("Failed to init AP.\n");
exit(EXIT_FAILURE);
}
ret = server_main();
} else {
- if (ap_init(NULL)) {
+ if (ouroboros_init(NULL)) {
printf("Failed to init AP.\n");
exit(EXIT_FAILURE);
}
@@ -179,7 +179,7 @@ int main(int argc, char ** argv)
ret = client_main();
}
- ap_fini();
+ ouroboros_fini();
if (ret < 0)
exit(EXIT_FAILURE);
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-01 00:05:31 +0000