SyncText

Extension

Description

SyncText keeps a text string synchronized across computers via the internet using OSCRouterClient. This is useful for shared coding practice, for learning, performances, and other uses.

First code examples:// if needed, close old synctext help docs to avoid confusion Document.allDocuments.do { |doc| if (doc.title.contains("synctext_help")) { doc.close } }; // make two OSCRouterClients and SyncTexts that share their text content. // typically these live on two different computers, // but for testing, this also works on a single computer // client and synctext 1 ~oscli1 = OSCRouterClient(\oscli1, 'syncTextTest', userPassword: \oscli1pw).join; ~tx1 = SyncText('synctext_help', ~oscli1.userName, ~oscli1); ~tx1.currText; ~tx1.showDoc; // (typically on computer 2: ~oscli2 = OSCRouterClient(\oscli2, 'syncTextTest', userPassword: \oscli2pw).join; ~tx2 = SyncText('synctext_help', ~oscli2.userName, ~oscli2); ~tx2.currText; ~tx2.showDoc; /// then type something in synxtext_help_oscli1, // and check that it shows up on synxtext_help_oscli2; // then check vice versa! // make a second synctext with two users, // to check that it works independently of synctext_help: ~tx3 = SyncText('synctext_help2', ~oscli1.userName, ~oscli1).showDoc; ~tx4 = SyncText('synctext_help2', ~oscli2.userName, ~oscli2).showDoc; // try writing to the four docs: the 2 ..help2 docs should sync, // and the 2 ..help docs should still sync independently. // Choose how much debug/sync posting you want: SyncText.verbosity = 0; // silence SyncText.verbosity = 1; // normal posting SyncText.verbosity = 2; // detailed posting for debugging complex setups // compare contents of ~tx1 and ~tx2 - should be the same: ~tx1.currText.cs; ~tx2.currText.cs; /// test SyncText access by name: SyncText.all; // lookup of instances works both with bare textID and textID_name: ~tx1 === SyncText('synctext_help', 'oscli1') ///// SyncText can be created incomplete without textID and relayAddr, ///// but currently there is no way to update them SyncText('testNoID'); SyncText('testID', 'user');

Class Methods

.new

.all

.defaultText

Instance Methods

.textID

.userID

.relayAddr

.currText

.textDoc

.showDoc

.enableSend

.disableSend

.sendEnabled

.lock

.unlock

.lock

.sendEnabled

mostly for internal use (and debugging)

.incomingVersions

.lastReceived

.lastSent

.docLocalID

.requestText

.setCurr

.setDocText

.sendSyncText

.synced

Examples