ApertureOS
socket.h
Go to the documentation of this file.
1 #ifndef _SOCKET_PROC_H_
2 #define _SOCKET_PROC_H_
3 
4 #include "types.h"
5 #include "managers.h"
6 
12 typedef uint32_t(*Sock_ReadAsync)(uint8_t* buffer, uint32_t size);
14 
16 typedef uint32_t(*Sock_SeekAsync)(uint64_t offset, int whence);
17 
19 typedef uint32_t(*Sock_WriteAsync)(uint8_t* src_buf, uint32_t size);
20 
22 typedef enum
23 {
24  SOCK_ERROR_NONE = 0,
25  SOCK_ERROR_UNKNOWN = 1 << 0,
26  SOCK_ERROR_NO_FREE_CONNECTIONS = 1 << 1,
27  SOCK_ERROR_NO_PERMS = 1 << 2,
28  SOCK_ERROR_FAILED_BUSY = 1 << 3,
29  SOCK_ERROR_EXISTS = 1 << 4,
30  SOCK_ERROR_NOT_EXIST = 1 << 5
31 } SOCK_ERROR;
32 
34 typedef enum
35 {
36  SOCK_FEAT_NONE = 0,
37  SOCK_FEAT_WRITABLE = 1,
38  SOCK_FEAT_READABLE = 2,
39  SOCK_FEAT_SEEKABLE = 4,
40  SOCK_FEAT_NOTIFICATION = 8,
41  SOCK_FEAT_SUPERVISOR = 32,
42 } SOCK_FEATURES;
43 
45 typedef enum
46 {
47  SOCK_NOTIFICATIONS_NONE = 0,
48  SOCK_NOTIFICATION_WRITE = 1<<0,
49  SOCK_NOTIFICATION_READ = 1<<1,
50  SOCK_NOTIFICATION_SEEK = 1<<2,
51  SOCK_NOTIFICATION_CONNECT = 1<<3,
52  SOCK_NOTIFICATION_DISCONNECT = 1<<4,
53  SOCK_NOTIFICATION_COMPLETE = 1 << 31
54 } SOCK_NOTIFICATIONS;
55 
57 typedef struct
58 {
59  uint32_t size;
60  uint32_t max_connections;
61 
62  Sock_ReadAsync read;
63  Sock_WriteAsync write;
64  Sock_SeekAsync seek;
65 
66  SOCK_FEATURES flags;
67  SOCK_NOTIFICATIONS notifications;
68 } SocketDesc;
69 
71 typedef struct
72 {
73  uint32_t size;
74 
75  SOCK_FEATURES requested_features;
76 } SocketConnectionDesc;
77 
78 
80 
85 SOCK_ERROR
86 Socket_Create(const char *name,
87  SocketDesc *desc);
88 
89 
91 
97 SOCK_ERROR
98 Socket_Connect(const char *name,
99  SocketConnectionDesc *desc,
100  UID *id);
101 
102 
104 
109 SOCK_ERROR
110 Socket_Disconnect(UID id);
111 
112 
114 
121 SOCK_ERROR
122 Socket_ReadAsync(UID id,
123  uint8_t *buffer,
124  uint32_t size);
125 
126 
128 
135 SOCK_ERROR
136 Socket_WriteAsync(UID id,
137  uint8_t *buffer,
138  uint32_t size);
139 
140 
142 
149 SOCK_ERROR
150 Socket_SeekAsync(UID id,
151  uint64_t offset,
152  int whence);
153 
156 #endif
SOCK_FEAT_READABLE
Socket may be read from.
Definition: socket.h:38
SOCK_NOTIFICATION_SEEK
Send notification on seek.
Definition: socket.h:50
SocketDesc::write
Sock_WriteAsync write
Function to read from the socket.
Definition: socket.h:63
Socket_WriteAsync
SOCK_ERROR Socket_WriteAsync(UID id, uint8_t *buffer, uint32_t size)
Request an asynchronous write to the socket.
Definition: socket.c:49
SocketConnectionDesc::requested_features
SOCK_FEATURES requested_features
The size of the struct. must be sizeof(SocketConnectionDesc)
Definition: socket.h:75
Sock_SeekAsync
uint32_t(* Sock_SeekAsync)(uint64_t offset, int whence)
A pointer to a function that asynchronously performs a Socket seek.
Definition: socket.h:16
Sock_ReadAsync
uint32_t(* Sock_ReadAsync)(uint8_t *buffer, uint32_t size)
A pointer to a function that asynchronously performs a Socket read.
Definition: socket.h:13
SOCK_ERROR
SOCK_ERROR
Socket errors.
Definition: socket.h:22
SocketDesc
The description of the socket.
Definition: socket.h:57
SOCK_FEAT_NOTIFICATION
Socket can send notifications into the message pump.
Definition: socket.h:40
Socket_Connect
SOCK_ERROR Socket_Connect(const char *name, SocketConnectionDesc *desc, UID *id)
Attempt to connect to a socket.
Definition: socket.c:17
SocketDesc::notifications
SOCK_NOTIFICATIONS notifications
Features supported by the socket.
Definition: socket.h:67
UID
uint64_t UID
Definition: types.h:8
SOCK_NOTIFICATION_COMPLETE
Signals the completion of an asynchronous action for the current thread.
Definition: socket.h:53
SOCK_NOTIFICATIONS_NONE
Send no notifications.
Definition: socket.h:47
SOCK_ERROR_NOT_EXIST
The socket does not exist.
Definition: socket.h:30
SOCK_FEAT_SEEKABLE
Socket is seekable.
Definition: socket.h:39
SOCK_ERROR_FAILED_BUSY
The socket is busy.
Definition: socket.h:28
Socket_ReadAsync
SOCK_ERROR Socket_ReadAsync(UID id, uint8_t *buffer, uint32_t size)
Request an asynchronous read from the socket.
Definition: socket.c:37
SocketConnectionDesc::size
uint32_t size
Definition: socket.h:73
Socket_Disconnect
SOCK_ERROR Socket_Disconnect(UID id)
Attempt to disconnect from the socket.
Definition: socket.c:29
SocketDesc::size
uint32_t size
Definition: socket.h:59
ProcessInfo::name
const char name[MAX_PROC_NAME_LEN]
Definition: process_man.h:22
SocketConnectionDesc
The description of the socket connection.
Definition: socket.h:71
SOCK_FEAT_SUPERVISOR
Request supervisor level access.
Definition: socket.h:41
SOCK_FEAT_WRITABLE
Socket can be written to.
Definition: socket.h:37
SOCK_FEAT_NONE
No features.
Definition: socket.h:36
SOCK_ERROR_UNKNOWN
Unknown error.
Definition: socket.h:25
SOCK_ERROR_NONE
No error.
Definition: socket.h:24
Socket_SeekAsync
SOCK_ERROR Socket_SeekAsync(UID id, uint64_t offset, int whence)
Request an asynchronous seek of the socket.
Definition: socket.c:61
SOCK_FEATURES
SOCK_FEATURES
Socket features.
Definition: socket.h:34
SOCK_NOTIFICATION_READ
Send notification on read.
Definition: socket.h:49
SocketDesc::read
Sock_ReadAsync read
The maximum number of connections allowed to the socket.
Definition: socket.h:62
Socket_Create
SOCK_ERROR Socket_Create(const char *name, SocketDesc *desc)
Create a new Socket and register it to the kernel.
Definition: socket.c:7
SocketDesc::max_connections
uint32_t max_connections
The size of the struct, must be sizeof(SocketDesc)
Definition: socket.h:60
SOCK_NOTIFICATIONS
SOCK_NOTIFICATIONS
Socket notifications.
Definition: socket.h:45
SOCK_NOTIFICATION_WRITE
Send notification on write.
Definition: socket.h:48
SOCK_NOTIFICATION_CONNECT
Send notification on connect.
Definition: socket.h:51
Sock_WriteAsync
uint32_t(* Sock_WriteAsync)(uint8_t *src_buf, uint32_t size)
A pointer to a function that asynchronously performs a Socket write.
Definition: socket.h:19
SOCK_ERROR_NO_PERMS
The calling thread doesn't have the permissions.
Definition: socket.h:27
SOCK_NOTIFICATION_DISCONNECT
Send notification on disconnect.
Definition: socket.h:52
SOCK_ERROR_EXISTS
The socket already exists.
Definition: socket.h:29
SocketDesc::flags
SOCK_FEATURES flags
Function to seek the socket.
Definition: socket.h:66
SocketDesc::seek
Sock_SeekAsync seek
Function to write to the socket.
Definition: socket.h:64
SOCK_ERROR_NO_FREE_CONNECTIONS
There are no free connections on this socket.
Definition: socket.h:26
Generated by   doxygen 1.8.9.1