bloom-lang / bud

Prototype Bud runtime (Bloom Under Development)
http://bloom-lang.net
Other
854 stars 59 forks source link

carefully expose & document the Bloom API and DSL #226

Open jhellerstein opened 13 years ago

jhellerstein commented 13 years ago

We have been sloppy about identifying what exactly is the "surface" of the Bud runtime that defines Bloom -- i.e. what you can do with Bud from Ruby. Our best documentation right now is the cheat sheet. Next best is the set of public methods in the BudCollection and Bud classes, but they are not as well documented as they could be.

Cleanly identifying this interface is important for replacing the runtime.

jhellerstein commented 13 years ago

Here is the list of documented methods in the 0.0.4 Rdoc:

MethodClass
accumBud
async_doBud
avgBud
bud_clockBud
channelBud
chooseBud
choose_randBud
close_tablesBud
countBud
dbm_tableBud
deltaBud
file_readerBud
int_ip_portBud
interfaceBud
ip_portBud
loopbackBud
maxBud
minBud
newBud
on_shutdownBud
periodicBud
post_shutdownBud
register_callbackBud
report_metricsBud
run_bgBud
run_fgBud
scratchBud
stop_bgBud
sumBud
sync_callbackBud
sync_doBud
tableBud
tctableBud
tempBud
tickBud
unregister_callbackBud
zktableBud
<=Bud::BudChannel
clone_emptyBud::BudChannel
payloadsBud::BudChannel
*Bud::BudCollection
<<Bud::BudCollection
<=Bud::BudCollection
[]Bud::BudCollection
argaggBud::BudCollection
argmaxBud::BudCollection
argminBud::BudCollection
exists?Bud::BudCollection
groupBud::BudCollection
has_key?Bud::BudCollection
include?Bud::BudCollection
inspectedBud::BudCollection
key_colsBud::BudCollection
keysBud::BudCollection
null_tupleBud::BudCollection
proBud::BudCollection
tick_metricsBud::BudCollection
valuesBud::BudCollection
combosBud::BudJoin
flattenBud::BudJoin
inspectedBud::BudJoin
leftsBud::BudJoin
matchesBud::BudJoin
outerBud::BudJoin
pairsBud::BudJoin
rightsBud::BudJoin
newBust::BustClass
newBust::BustClass::BustHandler
serveBust::BustClass::BustHandler
Method Class
renameEnumerable
newForkDeploy
add_collectionLibRebl
add_ruleLibRebl
del_ruleLibRebl
dumpLibRebl
newLibRebl
runLibRebl
stopLibRebl
tickLibRebl
bloomModule
bootstrapModule
deploystrapModule
importModule
stateModule
commandReblShell
rebl_loopReblShell
runReblShell
setupReblShell
setup_historyReblShell
finishSpaceTime
msg_edgeSpaceTime
newSpaceTime
processSpaceTime