Ouroboros API - Revision history

Dimitri at 06:10, 22 July 2024

2024-07-22T06:10:28Z

← Older revision		Revision as of 06:10, 22 July 2024
Line 12:		Line 12:
	</syntaxhighlight>		</syntaxhighlight>

	On the server side, the flow_accept() call is a blocking call that will wait for an incoming flow from a client. On the client side, the flow_alloc() call is a blocking call that allocates a flow to dst. Both calls return an non-negative integer number describing a “flow descriptor”, which is very similar to a file descriptor. On error, they will return a negative error code. (See the man page for all details). If the timeo parameter supplied is NULL, the calls will block indefinitely, otherwise flow_alloc() will return -ETIMEDOUT when the time interval provided by timeo expires. We are working on implementing non-blocking versions if the provided timeo is 0.		On the server side, the ''flow_accept()'' call is a blocking call that will wait for an incoming flow from a client. On the client side, the ''flow_alloc()'' call is a blocking call that allocates a flow to dst. Both calls return an non-negative integer number describing a “flow descriptor”, which is very similar to a file descriptor. On error, they will return a negative error code. (See the man page for all details). If the timeo parameter supplied is NULL, the calls will block indefinitely, otherwise flow_alloc() will return -ETIMEDOUT when the time interval provided by timeo expires. We are working on implementing non-blocking versions if the provided timeo is 0.

	After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.		After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.

Dimitri at 06:09, 22 July 2024

2024-07-22T06:09:37Z

← Older revision		Revision as of 06:09, 22 July 2024
Line 1:		Line 1:
	{{under construction}}		{{under construction}}

	The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].		The C man pages are part of the install and also available online [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].
	Also see [[Ouroboros Implementation Overview]].		Also see [[Ouroboros Implementation Overview]].

Dimitri at 08:12, 10 December 2023

2023-12-10T08:12:04Z

← Older revision		Revision as of 08:12, 10 December 2023
Line 7:		Line 7:
	We explain how to connect two applications. The server application uses the ''flow_accept()'' call to accept incoming connections and the client uses the ''flow_alloc()'' call to connect to the server. The flow_accept and flow_alloc call have the following definitions:		We explain how to connect two applications. The server application uses the ''flow_accept()'' call to accept incoming connections and the client uses the ''flow_alloc()'' call to connect to the server. The flow_accept and flow_alloc call have the following definitions:

	<~~SyntaxHighlight~~ lang=C>		<syntaxhighlight lang="C">
	int flow_accept(qosspec_t * qs, const struct timespec * timeo);		int flow_accept(qosspec_t * qs, const struct timespec * timeo);
	int flow_alloc(const char * dst, qosspec_t * qs, const struct timespec * timeo);		int flow_alloc(const char * dst, qosspec_t * qs, const struct timespec * timeo);
	</~~SyntaxHighlight~~>		</syntaxhighlight>

	On the server side, the flow_accept() call is a blocking call that will wait for an incoming flow from a client. On the client side, the flow_alloc() call is a blocking call that allocates a flow to dst. Both calls return an non-negative integer number describing a “flow descriptor”, which is very similar to a file descriptor. On error, they will return a negative error code. (See the man page for all details). If the timeo parameter supplied is NULL, the calls will block indefinitely, otherwise flow_alloc() will return -ETIMEDOUT when the time interval provided by timeo expires. We are working on implementing non-blocking versions if the provided timeo is 0.		On the server side, the flow_accept() call is a blocking call that will wait for an incoming flow from a client. On the client side, the flow_alloc() call is a blocking call that allocates a flow to dst. Both calls return an non-negative integer number describing a “flow descriptor”, which is very similar to a file descriptor. On error, they will return a negative error code. (See the man page for all details). If the timeo parameter supplied is NULL, the calls will block indefinitely, otherwise flow_alloc() will return -ETIMEDOUT when the time interval provided by timeo expires. We are working on implementing non-blocking versions if the provided timeo is 0.
Line 16:		Line 16:
	After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.		After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.

	<~~SyntaxHighlight~~ lang=C>		<syntaxhighlight lang="C">
	ssize_t flow_write(int fd, const void * buf, size_t count);		ssize_t flow_write(int fd, const void * buf, size_t count);
	ssize_t flow_read(int fd, void * buf, size_t count); int		ssize_t flow_read(int fd, void * buf, size_t count); int
	flow_dealloc(int fd);		flow_dealloc(int fd);
	</~~SyntaxHighlight~~>		</syntaxhighlight>

	So a very simple application would just need a couple of lines of code for both the server and the client:		So a very simple application would just need a couple of lines of code for both the server and the client:

	<~~SyntaxHighlight~~ lang=C>		<syntaxhighlight lang="C">
	/* server side */		/* server side */
	char msg[BUF_LEN];		char msg[BUF_LEN];
Line 36:		Line 36:
	flow_write(fd, msg, strlen(msg));		flow_write(fd, msg, strlen(msg));
	flow_dealloc(fd);		flow_dealloc(fd);
	</~~SyntaxHighlight~~>		</syntaxhighlight>

	The full code for an example is the [https://ouroboros.rocks/cgit/ouroboros/tree/src/tools/oecho/oecho.c oecho application] in the src/tools directory.		The full code for an example is the [https://ouroboros.rocks/cgit/ouroboros/tree/src/tools/oecho/oecho.c oecho application] in the src/tools directory.

Dimitri at 08:09, 10 December 2023

2023-12-10T08:09:29Z

← Older revision		Revision as of 08:09, 10 December 2023
Line 16:		Line 16:
	After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.		After the flow is allocated, the flow_read() and flow_write() calls are used to read from the flow descriptor. They operate just like the read() and write() POSIX calls. The default behaviour is that these calls will block. To release the resource, the flow can be deallocated using flow_dealloc.

			<SyntaxHighlight lang=C>
	ssize_t flow_write(int fd, const void * buf, size_t count);		ssize_t flow_write(int fd, const void * buf, size_t count);
	ssize_t flow_read(int fd, void * buf, size_t count); int		ssize_t flow_read(int fd, void * buf, size_t count); int
	flow_dealloc(int fd);		flow_dealloc(int fd);
			</SyntaxHighlight>

	So a very simple application would just need a couple of lines of code for both the server and the client:		So a very simple application would just need a couple of lines of code for both the server and the client:

			<SyntaxHighlight lang=C>
	/* server side */		/* server side */
	char msg[BUF_LEN];		char msg[BUF_LEN];
Line 33:		Line 36:
	flow_write(fd, msg, strlen(msg));		flow_write(fd, msg, strlen(msg));
	flow_dealloc(fd);		flow_dealloc(fd);
			</SyntaxHighlight>

	The full code for an example is the oecho application in the tools directory.		The full code for an example is the [https://ouroboros.rocks/cgit/ouroboros/tree/src/tools/oecho/oecho.c oecho application] in the src/tools directory.

	To compile your C program from the command line, you have to link -louroboros-dev. For instance, in the Ouroboros repository, you can do		To compile your C program from the command line, you have to link -louroboros-dev. For instance, in the Ouroboros repository, you can do

	cd src/tools/oecho		cd src/tools/oecho
	gcc -louroboros-dev oecho.c -o oecho		gcc -louroboros-dev oecho.c -o oecho

Dimitri at 08:07, 10 December 2023

2023-12-10T08:07:54Z

@@ Line 1: / Line 1: @@
 {{under construction}}
 The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].
 Also see [[Ouroboros Implementation Overview]].

Dimitri at 12:02, 9 December 2023

2023-12-09T12:02:41Z

← Older revision		Revision as of 12:02, 9 December 2023
Line 1:		Line 1:
	{{under construction}}		{{under construction}}

	Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.		Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.
	The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].		The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].
	Also see [[Ouroboros Implementation Overview]].		Also see [[Ouroboros Implementation Overview]].

Dimitri at 12:02, 9 December 2023

2023-12-09T12:02:31Z

← Older revision		Revision as of 12:02, 9 December 2023
Line 2:		Line 2:
	Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.		Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.
	The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].		The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].
	~~We might also link to~~ [[Ouroboros Implementation Overview]].		Also see [[Ouroboros Implementation Overview]].

Dimitri at 11:36, 5 December 2023

2023-12-05T11:36:47Z

← Older revision		Revision as of 11:36, 5 December 2023
Line 1:		Line 1:
	{{under construction}}		{{under construction}}
	Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.		Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.
			The C man pages are [https://ouroboros.rocks/man/man3/flow_alloc.3.html here].
	We might also link to [[Ouroboros Implementation Overview]].		We might also link to [[Ouroboros Implementation Overview]].

Thijs: Created page with "{{under construction}} Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended. We might also link to Ouroboros Implementation Overview."

2023-12-04T11:06:10Z

Created page with "{{under construction}} Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended. We might also link to Ouroboros Implementation Overview."

New page

{{under construction}}
Here, the [https://{{SERVERNAME}}/docs/examples/ examples] & [https://{{SERVERNAME}}/docs/api/ APIs] will be ported from the old website and extended.
We might also link to [[Ouroboros Implementation Overview]].