Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
add text about leaked OSC.
  • Loading branch information
2bbb committed May 14, 2015
1 parent 9f96a57 commit 00a6a90
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ publish/subscribe OSC message.
* [How to use](#HowToUse)
* [API](#API)
* [ofxSubscribeOsc](#API_ofxSubscribeOsc)
* [ofxSetLeakedOscPicker](#API_ofxSetLeakedOscPicker)
* [ofxPublishOsc](#API_ofxPublishOsc)
* [Supported types](#SupportedTypes)
* [Arithmetic](#SupportedTypes_Arithmetic)
Expand All @@ -20,7 +21,7 @@ publish/subscribe OSC message.
* [Special Thanks](#SpecialThanks)
* [At the last](#AtTheLast)

## <a name="HowToUse"> How to use
## <a name="HowToUse">How to use</a>

```
Expand Down Expand Up @@ -66,6 +67,22 @@ unbind OSC message has _address_ incoming from _port_.

unbind all OSC messages incoming from _port_.

#### See [class ofxOscSubscriber](#Advanced_ofxOscSubscriber)

### <a name="API_ofxSetLeakedOscPicker">ofxSetLeakedOscPicker</a>

* void ofxSetLeakedOscPicker(int _port_, void (\*_callback_)(ofxOscMessage &))
* template \<typename T\> void ofxSetLeakedOscPicker(int _port_, T \*_that_, void (T::\*_callback_)(ofxOscMessage &))
* template \<typename T\> void ofxSetLeakedOscPicker(int _port_, T &_that_, void (T::\*_callback_)(ofxOscMessage &))

set callback for port. this callback is kick when receive OSC message has not binded address.

* void ofxRemoveLeakedOscPicker(int _port_)

remove callback.

#### See [Legacy style pick up leaked OSC](#Advanced_LegacyStylePickUpLeakedOSCMessage)

### <a name="API_ofxPublishOsc">ofxPublishOsc</a>

* template \<typename T\> ofxPublishOsc(const string &_ip_, int _port_, const string &_address_, T &_value_, bool _whenValueIsChanged_ = **true**);
Expand All @@ -83,6 +100,22 @@ unpublish OSC message has _address_ is send to _ip:port_.

unpublish all OSC messages is send to _ip:port_.

#### See [class ofxOscPublisher](#Advanced_ofxOscPublisher)

## <a name="AdvancedAPI">Advanced API</a>

### <a name="Advanced_ofxOscSubscriber">class ofxOscSubscriber</a>

TODO

#### <a name="Advanced_LegacyStylePickUpLeakedOSCMessage">How to "Legacy style pick up leaked OSC"</a>

TODO

### <a name="Advanced_ofxOscPublisher">class ofxOscPublisher</a>

TODO

## <a name="SupportedTypes">Supported types</a>

### <a name="SupportedTypes_Arithmetic">Arithmetic (Int32, Int64, Float)</a>
Expand Down

0 comments on commit 00a6a90

Please sign in to comment.