summaryrefslogtreecommitdiff
path: root/include/ouroboros/ipcp.h
blob: 3198a88269c119cabcf25ba6c57eb0409026e4c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 * Ouroboros - Copyright (C) 2016
 *
 * The API for the IRM to instruct IPCPs
 *
 *    Sander Vrijders <sander.vrijders@intec.ugent.be>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef OUROBOROS_IPCP_H
#define OUROBOROS_IPCP_H

#include <ouroboros/common.h>
#include <ouroboros/dif_config.h>
#include <ouroboros/instance_name.h>
#include <ouroboros/sockets.h>

#include <sys/types.h>

struct ipcp;

/* Returns the process id */
pid_t ipcp_create(instance_name_t * api,
                  enum ipcp_type    ipcp_type);

int   ipcp_destroy(pid_t pid);

int   ipcp_reg(pid_t   pid,
               char ** difs,
               size_t  difs_size);
int   ipcp_unreg(pid_t   pid,
                 char ** difs,
                 size_t  difs_size);

int   ipcp_enroll(pid_t  pid,
                  char * member_name,
                  char * n_1_dif);

int   ipcp_bootstrap(pid_t pid,
                     dif_config_msg_t * conf);

/* Flow related ops, these go from IRMd to IPCP */

int   ipcp_ap_reg(pid_t    pid,
                  uint32_t reg_api_id,
                  char *   ap_name);
int   ipcp_ap_unreg(pid_t    pid,
                    uint32_t reg_api_id);

int   ipcp_flow_alloc(pid_t             pid,
                      uint32_t          port_id,
                      char *            dst_ap_name,
                      char *            src_ap_name,
                      char *            src_ae_name,
                      struct qos_spec * qos);
int   ipcp_flow_alloc_resp(pid_t    pid,
                           uint32_t port_id,
                           int      result);

/* These operations go from the IPCP to the IRMd */

/* Returns the port_id */
int   ipcp_flow_req_arr(pid_t    pid,
                        uint32_t reg_api_id,
                        char *   ap_name,
                        char *   ae_name);
int   ipcp_flow_alloc_reply(pid_t    pid,
                            uint32_t port_id,
                            int      result);

/*
 * This operation can go both ways
 * pid == 0 means the IRMd is the destination
 */
int   ipcp_flow_dealloc(pid_t    pid,
                        uint32_t port_id);


#endif /* OUROBOROS_IPCP_H */