summaryrefslogtreecommitdiffstats
path: root/libraries/oscP5/src/oscP5/OscPacket.java
blob: 4e9cc59ae073374b33f92d480e7130a9f92fdb96 (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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/**
 * An OSC (Open Sound Control) library for processing.
 *
 * (c) 2004-2012
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA  02111-1307  USA
 * 
 * @author		Andreas Schlegel http://www.sojamo.de
 * @modified	12/23/2012
 * @version		0.9.9
 */

package oscP5;

import java.net.DatagramPacket;
import java.net.InetAddress;
import netP5.Bytes;
import netP5.NetAddress;
import netP5.TcpPacket;
import netP5.TcpClient;

/**
 * @invisible
 */
public abstract class OscPacket extends OscPatcher {

    protected static final int MESSAGE = 0;


    protected static final int BUNDLE = 1;


    protected InetAddress inetAddress;


    protected String hostAddress;


    protected int _myType;


    protected TcpClient _myTcpClient = null;


    protected int port;

    /**
     * @invisible
     */
    public OscPacket() {}


    protected static OscPacket parse(DatagramPacket theDatagramPacket) {
        if (evaluatePacket(theDatagramPacket.getData()) == MESSAGE) {
            return new OscMessage(theDatagramPacket);
        } else {
            return new OscBundle(theDatagramPacket);
        }
    }


    protected static OscPacket parse(TcpPacket theTcpPacket) {
        if (evaluatePacket(theTcpPacket.getData()) == MESSAGE) {
            return new OscMessage(theTcpPacket);
        } else {
            return new OscBundle(theTcpPacket);
        }
    }


    private static int evaluatePacket(byte[] theBytes) {
        return (Bytes.areEqual(OscBundle.BUNDLE_AS_BYTES, Bytes.copy(theBytes, 0, OscBundle.BUNDLE_AS_BYTES.length))) ? BUNDLE
                : MESSAGE;
    }


    /**
     * when in TCP mode, tcpConnection() returns the instance of the TcpClient that has sent the OscMessage.
     * @return TcpClient
     */
    public TcpClient tcpConnection() {
        return _myTcpClient;
    }


    protected boolean isValid() {
        return isValid;
    }


    protected int type() {
        return _myType;
    }


    public int port() {
        return port;
    }


    public NetAddress netAddress() {
        return new NetAddress(inetAddress, port);
    }


    /**
     * @deprecated
     * @invisible
     * @return NetAddress
     */
    public NetAddress netaddress() {
        return new NetAddress(inetAddress, port);
    }


    /**
     * @return String
     */
    public String address() {
        return hostAddress;
    }


    /**
     * @return byte[]
     * @invisible
     */
    public abstract byte[] getBytes();

}