OSCObjectSpace
Extension
ExtensionDescription
Sync simple data types between Peers. Unlike OSCDataSpace it supports more than just OSC data types. It functions similarly to a IdentityDictionary in its basic operation (i.e. you can use at and put)
Important Issues when using OSCObjectSpace
- Only objects which can be archived (i.e. those that do not contain open functions) can be sent
- OSCObjectSpace does not track internal changes in the objects it holds. You can set the key again with the changed object, but this will result in a new object being made in other Peer's object spaces, not the old one being changed. If you want to sync changes to remote objects the OpenObject quark might be better.
- OSCObjectSpace can constitute a security risk, since a malicious party could insert a pseudo-object spoofing something else. For this reason, by default it does not accept Events, although you can enable that. For safety it is best to use it on a secure network, and with encryption. If auto-discovering peers on an open network, the use of an autheniticator such as ChallengeAuthenticator can provide additional security.
Class Methods
.new
(describe method here)
Arguments:
| addrBook |
an AddrBook where Peers are registered |
| acceptEvents |
A Boolean indicating whether Events are permitted in this OSCObjectSpace. |
| oscPath |
the oscPath to use when relaying |
| encryptor |
an (optional) encryptor for sending objects |
Returns:
a new OSCObjectSpace
Instance Methods
.getPairs
.acceptEvents
Get or set a Boolean indicating whether this OSCObjectSpace accepts Events. Changing this will not purge any currently stored Events.
Returns:
a Boolean
.validate
Get or set a Boolean indicating whether this OSCObjectSpace validates received objects by searching for particular high risk strings (unixCmd, systemCmd, Pipe, File). Objects which do not pass validation are rejected. The default is true.
Returns:
a Boolean