summaryrefslogtreecommitdiffstats
path: root/dom/media/webrtc/transport/third_party/nICEr/src/ice/ice_handler.h
blob: 5a0690adad330edbd5ed390705f22b08df9957a3 (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
/*
Copyright (c) 2007, Adobe Systems, Incorporated
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

* Neither the name of Adobe Systems, Network Resonance nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/



#ifndef _ice_h
#define _ice_h
#ifdef __cplusplus
using namespace std;
extern "C" {
#endif /* __cplusplus */

typedef struct nr_ice_handler_vtbl_ {
  /* The checks on this media stream are done. The handler needs to
     select a single pair to proceed with (regular nomination).
     Once this returns the check starts and the pair can be
     written on. Use nr_ice_candidate_pair_select() to perform the
     selection.
     TODO: !ekr! is this right?
  */
  int (*select_pair)(void *obj,nr_ice_media_stream *stream,
int component_id, nr_ice_cand_pair **potentials,int potential_ct);

  /* This media stream is ready to read/write (aggressive nomination).
     May be called again if the nominated pair changes due to
     ICE instability. TODO: !ekr! think about this
  */
  int (*stream_ready)(void *obj, nr_ice_media_stream *stream);

  /* This media stream has failed */
  int (*stream_failed)(void *obj, nr_ice_media_stream *stream);

  /* ICE is connected for this peer ctx */
  int (*ice_connected)(void *obj, nr_ice_peer_ctx *pctx);

  /* A message was delivered to us */
  int (*msg_recvd)(void *obj, nr_ice_peer_ctx *pctx, nr_ice_media_stream *stream, int component_id, UCHAR *msg, int len);

  /* ICE has started checking. */
  int (*ice_checking)(void *obj, nr_ice_peer_ctx *pctx);

  /* ICE detected a (temporary?) disconnect. */
  int (*ice_disconnected)(void *obj, nr_ice_peer_ctx *pctx);
} nr_ice_handler_vtbl;

typedef struct nr_ice_handler_ {
  void *obj;
  nr_ice_handler_vtbl *vtbl;
} nr_ice_handler;

#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif