Skip to content

Commit

Permalink
added details for memory function (.mem.objsize)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonnypress committed Dec 4, 2015
1 parent 1812dff commit 1571ce6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions code/common/apidetails.q
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,6 @@ add[`.email.disconnect;1b;"disconnect from email server";"[]";"0"]

// tplog
add[`.tplog.check;1b;"Checks if tickerplant log can be replayed. If it can or can replay the first X messages, then returns the log handle, else it will read log as byte stream and create a good log and then return the good log handle ";"[logfile (symbol), handle to the log file to check; lastmsgtoreplay (long), the index of the last message to be replayed from log ]";"handle to log file, will be either the input log handle or handle to repaired log, depends on whether the log was corrupt"]

// memory usage
add[`.mem.objsize;1b;"Returns the calculated memory size in bytes used by an object. It may take a little bit of time for objects with lots of nested structures (e.g. lots of nested columns)";"[q object]";"size of the object in bytes"]

0 comments on commit 1571ce6

Please sign in to comment.