mirror of
https://github.com/ultimatepp/ultimatepp.git
synced 2026-05-31 22:04:04 -06:00
.doc Fix link issues in Core (one more time)
git-svn-id: svn://ultimatepp.org/upp/trunk@9972 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
klugier
parent
c967278f53
commit
af2fe45cc4
5 changed files with 119 additions and 87 deletions
|
|
@ -27,8 +27,8 @@ type.&]
|
|||
[s2; Constructs an empty Any.&]
|
||||
[s3; &]
|
||||
[s4;%- &]
|
||||
[s5;:Any`:`:Any`(pick`_ Any`&`):%- [* Any]([@(0.128.128) pick`_]_[* Any][@(0.0.255) `&]_[*@3 s])
|
||||
&]
|
||||
[s5;:Any`:`:Any`(pick`_ Any`&`):%- [* Any]([@(0.128.128) pick`_]_[_^topic`:`/`/Core`/src`/Any`$en`-us`#Any`:`:class^ A
|
||||
ny][@(0.0.255) `&]_[*@3 s])&]
|
||||
[s2; Pick constructor. Transfers content of source [* Any] [%-*@3 s]
|
||||
while destroying its content by picking..&]
|
||||
[s3; &]
|
||||
|
|
@ -77,11 +77,12 @@ this operation is illegal.&]
|
|||
[s7; [*/ Return value]-|true if there is no content.&]
|
||||
[s3;%- &]
|
||||
[s4;%- &]
|
||||
[s5;:Upp`:`:Any`:`:operator`=`(Upp`:`:Any`&`&`):%- [@(0.0.255) void]_[* operator`=]([_^Upp`:`:Any^ A
|
||||
[s5;:Upp`:`:Any`:`:operator`=`(Upp`:`:Any`&`&`):%- [@(0.0.255) void]_[* operator`=]([_^topic`:`/`/Core`/src`/Any`$en`-us`#Any`:`:class^ A
|
||||
ny][@(0.0.255) `&`&]_[*@3 s])&]
|
||||
[s2; Pick assignment.&]
|
||||
[s3; &]
|
||||
[s4;%- &]
|
||||
[s5;:Upp`:`:Any`:`:Any`(Upp`:`:Any`&`&`):%- [* Any]([* Any][@(0.0.255) `&`&]_[*@3 s])&]
|
||||
[s5;:Upp`:`:Any`:`:Any`(Upp`:`:Any`&`&`):%- [* Any]([_^topic`:`/`/Core`/src`/Any`$en`-us`#Any`:`:class^ A
|
||||
ny][@(0.0.255) `&`&]_[*@3 s])&]
|
||||
[s2; Pick constructor.&]
|
||||
[s0; ]]
|
||||
|
|
@ -17,40 +17,44 @@ your application and system environment.&]
|
|||
[s0;%% &]
|
||||
[ {{10000F(128)G(128)@1 [s0;%% [* Function List]]}}&]
|
||||
[s3; &]
|
||||
[s5;:GetExeFilePath`(`): [_^String^ String]_[* GetExeFilePath]()&]
|
||||
[s5;:GetExeFilePath`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ Stri
|
||||
ng]_[* GetExeFilePath]()&]
|
||||
[s2;%% Returns the absolute path towards the application`'s binary.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetEnv`(const char`*`): [_^String^ String]_[* GetEnv]([@(0.0.255) const]_[@(0.0.255) cha
|
||||
r]_`*[*@3 id])&]
|
||||
[s5;:GetEnv`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetEnv]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 id])&]
|
||||
[s2;%% Returns the value of the environment variable [*@3 id].&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:GetExeDirFile`(const char`*`): [_^String^ String]_[* GetExeDirFile]([@(0.0.255) const]_
|
||||
[@(0.0.255) char]_`*[*@3 fp])&]
|
||||
[s5;:GetExeDirFile`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetExeDirFile]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 fp])&]
|
||||
[s2;%% Returns the absolute path of a file that is found in the folder
|
||||
where you application`'s binary resides.&]
|
||||
[s2;%% [*@(129.0.0) fp][@(129.0.0) ..................................................]the
|
||||
name of the file&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetHomeDirectory`(`): [_^String^ String]_[* GetHomeDirectory]()&]
|
||||
[s5;:GetHomeDirectory`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ St
|
||||
ring]_[* GetHomeDirectory]()&]
|
||||
[s2;%% Returns the absolute path of current user`'s home folder.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetHomeDirFile`(const char`*`): [_^String^ String]_[* GetHomeDirFile]([@(0.0.255) cons
|
||||
t]_[@(0.0.255) char]_`*[*@3 fp])&]
|
||||
[s5;:GetHomeDirFile`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetHomeDirFile]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 fp])&]
|
||||
[s2;%% Returns the absolute path of a file that is found in the current
|
||||
user`'s home folder.&]
|
||||
[s7;%% [*@3 fp]..................................................the
|
||||
name of the file&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetExeTitle`(`): [_^String^ String]_[* GetExeTitle]()&]
|
||||
[s5;:GetExeTitle`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String]_
|
||||
[* GetExeTitle]()&]
|
||||
[s2;%% Returns the title of the application.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:Upp`:`:GetExeFolder`(`): [_^Upp`:`:String^ String]_[* GetExeFolder]()&]
|
||||
[s5;:Upp`:`:GetExeFolder`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetExeFolder]()&]
|
||||
[s2;%% Return the directory of application executable.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -63,27 +67,31 @@ binary resides.&]
|
|||
home folder (true) or application folder (false)&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:ConfigFile`(const char`*`): [_^String^ String]_[* ConfigFile]([@(0.0.255) const]_[@(0.0.255) c
|
||||
har]_`*[*@3 file])&]
|
||||
[s5;:ConfigFile`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* ConfigFile]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 file])&]
|
||||
[s2;%% Returns the absolute path of a configuration file found in
|
||||
the configuration files search path.&]
|
||||
[s2;%% [*@(129.0.0) file]...............................................the
|
||||
name of the file&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:ConfigFile`(`): [_^String^ String]_[* ConfigFile]()&]
|
||||
[s5;:ConfigFile`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String]_
|
||||
[* ConfigFile]()&]
|
||||
[s2;%% Returns the default configuration file from the configuration
|
||||
files search path. The default configuration file is called [*/ `[application
|
||||
title`]][* .cfg].&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:CommandLine`(`): [@(0.0.255) const]_[_^Vector^ Vector][@(0.0.255) <][_^String^ String][@(0.0.255) >
|
||||
[s5;:CommandLine`(`): [@(0.0.255) const]_[_^topic`:`/`/Core`/src`/Vector`$en`-us`#Vector`:`:class^ V
|
||||
ector][@(0.0.255) <][_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String][@(0.0.255) >
|
||||
`&]_[* CommandLine]()&]
|
||||
[s2;%% Return a vector of strings containing the command line parameters.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:Environment`(`): [@(0.0.255) const]_[_^VectorMap^ VectorMap][@(0.0.255) <][_^String^ Str
|
||||
ing], [_^String^ String][@(0.0.255) >`&]_[* Environment]()&]
|
||||
[s5;:Environment`(`): [@(0.0.255) const]_[_^topic`:`/`/Core`/src`/VectorMap`$en`-us`#VectorMap`:`:class^ V
|
||||
ectorMap][@(0.0.255) <][_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ Stri
|
||||
ng], [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String][@(0.0.255) >`&
|
||||
]_[* Environment]()&]
|
||||
[s2;%% Returns a vector of strings with system environment variables.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -102,8 +110,8 @@ exit code&]
|
|||
not yet exited the main function.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetDataFile`(const char`*`): [_^String^ String]_[* GetDataFile]([@(0.0.255) const]_[@(0.0.255) c
|
||||
har]_`*[*@3 filename])&]
|
||||
[s5;:GetDataFile`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetDataFile]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 filename])&]
|
||||
[s2;%% This function is designed to retrieve the path of file that
|
||||
contains application specific data. Behaviour depends on whether
|
||||
application was started from `'theide`' `- in that case theide
|
||||
|
|
@ -114,8 +122,8 @@ to GetExeDirFile. Alternatively, application can call SetDataPath
|
|||
to define the directory.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:LoadDataFile`(const char`*`): [_^String^ String]_[* LoadDataFile]([@(0.0.255) const]_[@(0.0.255) c
|
||||
har]_`*[*@3 filename])&]
|
||||
[s5;:LoadDataFile`(const char`*`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* LoadDataFile]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 filename])&]
|
||||
[s2;%% Same as LoadFile(GetDataFile([%-*@3 filename])).&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
|
|
@ -124,22 +132,26 @@ har]_`*[*@3 path])&]
|
|||
[s2;%% Defines explicit directory to be used with GetDataFile.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:GetComputerName`(`): [_^String^ String]_[* GetComputerName]()&]
|
||||
[s5;:GetComputerName`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ Str
|
||||
ing]_[* GetComputerName]()&]
|
||||
[s2;%% Returns the name of computer.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetUserName`(`): [_^String^ String]_[* GetUserName]()&]
|
||||
[s5;:GetUserName`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String]_
|
||||
[* GetUserName]()&]
|
||||
[s2;%% Returns current user.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:GetDesktopManager`(`): [_^String^ String]_[* GetDesktopManager]()&]
|
||||
[s5;:GetDesktopManager`(`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetDesktopManager]()&]
|
||||
[s2;%% Returns current GUI identifier. Predefined values are `"windows`",
|
||||
`"gnome`", `"kde`". If X11 desktop manager is not in this list,
|
||||
the value of `"DESKTOP`_SESSION`" environment variable is returned.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:LaunchWebBrowser`(const String`&`): [@(0.0.255) void]_[* LaunchWebBrowser]([@(0.0.255) c
|
||||
onst]_[_^String^ String][@(0.0.255) `&]_[*@3 url])&]
|
||||
onst]_[_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String][@(0.0.255) `&
|
||||
]_[*@3 url])&]
|
||||
[s2;%% Opens an URL in the default Web Browser.&]
|
||||
[s2;%% [*@(129.0.0) url]................................................the
|
||||
URL that will be opened in the browser&]
|
||||
|
|
|
|||
|
|
@ -17,7 +17,8 @@ topic "ArrayIndex";
|
|||
[s1;:ArrayIndex`:`:class: [@(0.0.255) class]_[* ArrayIndex]_:_[@(0.0.255) private]_[*@3 Moveab
|
||||
leAndDeepCopyOption][@(0.0.255) <]_[* ArrayIndex][@(0.0.255) <][*@4 T],
|
||||
[*@4 HashFn]_>_>, [@(0.0.255) public]_[*@3 AIndex][@(0.0.255) <][*@4 T],
|
||||
[_^Array^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >], [*@4 HashFn][@(0.0.255) >]_&]
|
||||
[_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >
|
||||
], [*@4 HashFn][@(0.0.255) >]_&]
|
||||
[s8;%% [*@4 T]-|Type or base class of elements stored in Array. There
|
||||
is no common requirement for T.&]
|
||||
[s8;%% [*@4 HashFn]-|Hashing class. Must have defined unsigned operator()(const
|
||||
|
|
@ -54,30 +55,33 @@ copy constructor.&]
|
|||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:ArrayIndex`(Upp`:`:Array`<T`>`&`&`): [@(0.0.255) explicit]_[* A
|
||||
rrayIndex]([_^Upp`:`:Array^ Array]<[*@4 T]>`&`&_[*@3 s])&]
|
||||
rrayIndex]([_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ Array]<[*@4 T]>`&`&
|
||||
_[*@3 s])&]
|
||||
[s2;%% Pick constructor from Array.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:ArrayIndex`:`:ArrayIndex`(const Array`<T`>`&`,int`): [* ArrayIndex]([@(0.0.255) cons
|
||||
t]_[_^Array^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >`&]_[*@3 s], [@(0.0.255) int])&]
|
||||
t]_[_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >
|
||||
`&]_[*@3 s], [@(0.0.255) int])&]
|
||||
[s2;%% Deep`-copy constructs ArrayIndex from Array.&]
|
||||
[s6;%% Requires T to have deep copy constructor or optional deep
|
||||
copy constructor.&]
|
||||
[s7;%% [*C@3 s]-|Source Vector.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:operator`=`(Upp`:`:Array`<T`>`&`&`): [_^Upp`:`:ArrayIndex^ Ar
|
||||
rayIndex][@(0.0.255) `&]_[* operator`=]([_^Upp`:`:Array^ Array]<[*@4 T]>`&`&_[*@3 x])&]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:operator`=`(Upp`:`:Array`<T`>`&`&`): [_^topic`:`/`/Core`/src`/ArrayIndex`$en`-us`#ArrayIndex`:`:class^ A
|
||||
rrayIndex][@(0.0.255) `&]_[* operator`=]([_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ A
|
||||
rray]<[*@4 T]>`&`&_[*@3 x])&]
|
||||
[s2;%% Pick assignment from Array.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:operator`=`(Upp`:`:ArrayIndex`<T`>`&`&`): [_^Upp`:`:ArrayIndex^ A
|
||||
rrayIndex][@(0.0.255) `&]_[* operator`=]([_^Upp`:`:ArrayIndex^ ArrayIndex]<[*@4 T]>`&`&_[*@3 x
|
||||
])&]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:operator`=`(Upp`:`:ArrayIndex`<T`>`&`&`): [_^topic`:`/`/Core`/src`/ArrayIndex`$en`-us`#ArrayIndex`:`:class^ A
|
||||
rrayIndex][@(0.0.255) `&]_[* operator`=]([_^topic`:`/`/Core`/src`/ArrayIndex`$en`-us`#ArrayIndex`:`:class^ A
|
||||
rrayIndex]<[*@4 T]>`&`&_[*@3 x])&]
|
||||
[s2;%% Pick assignment.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:Upp`:`:ArrayIndex`:`:ArrayIndex`(std`:`:initializer`_list`<T`>`): [* ArrayIndex]([_^std`:`:initializer`_list^ s
|
||||
[s5;:Upp`:`:ArrayIndex`:`:ArrayIndex`(std`:`:initializer`_list`<T`>`): [* ArrayIndex]([_^http`:`/`/en`.cppreference`.com`/w`/cpp`/utility`/initializer`_list^ s
|
||||
td`::initializer`_list]<[*@4 T]>_[*@3 init])&]
|
||||
[s2; C`+`+ 11 initialization.&]
|
||||
[s3;%% &]
|
||||
|
|
|
|||
|
|
@ -18,7 +18,8 @@ topic "ArrayMap";
|
|||
[s1;:ArrayMap`:`:class:%- [@(0.0.255) class]_[* ArrayMap]_:_[@(0.0.255) public]_[*@3 MoveableA
|
||||
ndDeepCopyOption][@(0.0.255) <]_[* ArrayMap][@(0.0.255) <][*@4 K], [*@4 T],
|
||||
[*@4 HashFn][@(0.0.255) >]_>, [@(0.0.255) public]_[*@3 AMap][@(0.0.255) <]_[*@4 K],
|
||||
[*@4 T], [_^Array^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >], [*@4 HashFn]_>_&]
|
||||
[*@4 T], [_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ Array][@(0.0.255) <][*@4 T
|
||||
][@(0.0.255) >], [*@4 HashFn]_>_&]
|
||||
[s8; [*@4 K]-|Type of keys. K must have deep copy constructor, be [/^dpp`:`/`/SourceDoc`/Containers`/Moveable^ m
|
||||
oveable] and must have operator`=`= defined.&]
|
||||
[s8; [*@4 T]-|Type or base class of the values stored in ArrayMap. There
|
||||
|
|
@ -54,8 +55,9 @@ T, Array<T>, HashFn >]&]
|
|||
[s3; &]
|
||||
[s4;%- &]
|
||||
[s5;:Upp`:`:ArrayMap`:`:ArrayMap`(std`:`:initializer`_list`<std`:`:pair`<K`,T`>`>`):%- [* A
|
||||
rrayMap]([_^std`:`:initializer`_list^ std`::initializer`_list]<[_^http`:`/`/en`.cppreference`.com`/w`/cpp`/utility`/pair^ s
|
||||
td`::pair]<[*@4 K], [*@4 T]>>_[*@3 init])&]
|
||||
rrayMap]([_^http`:`/`/en`.cppreference`.com`/w`/cpp`/utility`/initializer`_list^ st
|
||||
d`::initializer`_list]<[_^http`:`/`/en`.cppreference`.com`/w`/cpp`/utility`/pair^ st
|
||||
d`::pair]<[*@4 K], [*@4 T]>>_[*@3 init])&]
|
||||
[s2; C`+`+ 11 initialization.&]
|
||||
[s3; &]
|
||||
[s4;%- &]
|
||||
|
|
@ -70,9 +72,9 @@ of type derived from T.&]
|
|||
[s3; &]
|
||||
[s4;%- &]
|
||||
[s5;:ArrayMap`:`:ArrayMap`(pick`_ Index`<K`,HashFn`>`&`,pick`_ Array`<T`>`&`):%- [* Arr
|
||||
ayMap]([@(0.128.128) pick`_]_[_^Index^ Index][@(0.0.255) <][*@4 K], [*@4 HashFn][@(0.0.255) >
|
||||
`&]_[*@3 ndx], [@(0.128.128) pick`_]_[_^Array^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >`&]_[*@3 v
|
||||
al])&]
|
||||
ayMap]([@(0.128.128) pick`_]_[_^topic`:`/`/Core`/src`/Indext`$en`-us`#Index`:`:class^ I
|
||||
ndex][@(0.0.255) <][*@4 K], [*@4 HashFn][@(0.0.255) >`&]_[*@3 ndx], [@(0.128.128) pick`_]_[_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ A
|
||||
rray][@(0.0.255) <][*@4 T][@(0.0.255) >`&]_[*@3 val])&]
|
||||
[s2; Pick`-constructs ArrayMap from Index of keys and Array of values.
|
||||
The source containers should have equal number of elements.&]
|
||||
[s7; [*C@3 ndx]-|Source Index.&]
|
||||
|
|
@ -80,8 +82,9 @@ The source containers should have equal number of elements.&]
|
|||
[s3; &]
|
||||
[s4;%- &]
|
||||
[s5;:ArrayMap`:`:ArrayMap`(pick`_ Vector`<K`>`&`,pick`_ Array`<T`>`&`):%- [* ArrayMap](
|
||||
[@(0.128.128) pick`_]_[_^Vector^ Vector][@(0.0.255) <][*@4 K][@(0.0.255) >`&]_[*@3 ndx],
|
||||
[@(0.128.128) pick`_]_[_^Array^ Array][@(0.0.255) <][*@4 T][@(0.0.255) >`&]_[*@3 val])&]
|
||||
[@(0.128.128) pick`_]_[_^topic`:`/`/Core`/src`/Vector`$en`-us`#Vector`:`:class^ Vecto
|
||||
r][@(0.0.255) <][*@4 K][@(0.0.255) >`&]_[*@3 ndx], [@(0.128.128) pick`_]_[_^topic`:`/`/Core`/src`/Array`$en`-us`#Array`:`:class^ A
|
||||
rray][@(0.0.255) <][*@4 T][@(0.0.255) >`&]_[*@3 val])&]
|
||||
[s2; Pick`-constructs ArrayMap from Vector of keys and Array of values.
|
||||
The source containers should have equal number of elements.&]
|
||||
[s7; [*C@3 ndx]-|Source Index.&]
|
||||
|
|
|
|||
|
|
@ -19,14 +19,15 @@ operations.&]
|
|||
[s3; &]
|
||||
[ {{10000F(128)G(128)@1 [s0;%% [* Public Method List]]}}&]
|
||||
[s3; &]
|
||||
[s5;:TcpSocket`:`:WhenWait: [_^Callback^ Callback]_[* WhenWait]&]
|
||||
[s5;:TcpSocket`:`:WhenWait: [_^topic`:`/`/Core`/src`/Callbacks`$en`-us`#Callback`:`:class^ C
|
||||
allback]_[* WhenWait]&]
|
||||
[s2;%% If this callback is defined, it is invoked periodically while
|
||||
TcpSocket performs any operations, with the frequency 50Hz. This
|
||||
is intended to give user feedback in interactive applications.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:GetHostName`(`): [@(0.0.255) static] [_^String^ String]_[* GetHostName]()
|
||||
&]
|
||||
[s5;:TcpSocket`:`:GetHostName`(`): [@(0.0.255) static] [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetHostName]()&]
|
||||
[s2;%% Returns the name of computer.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -59,8 +60,8 @@ that case, all subsequent request are ignored.&]
|
|||
API or it can be `-1 for other errors.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:GetErrorDesc`(`)const: [_^String^ String]_[* GetErrorDesc]()_[@(0.0.255) c
|
||||
onst]&]
|
||||
[s5;:TcpSocket`:`:GetErrorDesc`(`)const: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetErrorDesc]()_[@(0.0.255) const]&]
|
||||
[s2;%% Returns description of error.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -86,8 +87,8 @@ request are ignored. Intended to be called from WhenWait routine.&]
|
|||
non`-blocking from host OS perspective.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:GetPeerAddr`(`)const: [_^String^ String]_[* GetPeerAddr]()_[@(0.0.255) co
|
||||
nst]&]
|
||||
[s5;:TcpSocket`:`:GetPeerAddr`(`)const: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetPeerAddr]()_[@(0.0.255) const]&]
|
||||
[s2;%% Returns the peer address.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -104,8 +105,8 @@ is blocking with respect to resolving host name. Returns true
|
|||
when connection process is successfully started.&]
|
||||
[s3; &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Connect`(IpAddrInfo`&`): [@(0.0.255) bool]_[* Connect]([_^IpAddrInfo^ IpA
|
||||
ddrInfo][@(0.0.255) `&]_[*@3 info])&]
|
||||
[s5;:TcpSocket`:`:Connect`(IpAddrInfo`&`): [@(0.0.255) bool]_[* Connect]([_^topic`:`/`/Core`/src`/IpAddrInfo`$en`-us`#IpAddrInfo`:`:class^ I
|
||||
pAddrInfo][@(0.0.255) `&]_[*@3 info])&]
|
||||
[s2;%% Connects socket to server found at [%-*@3 info]. Non`-blocking.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
|
|
@ -120,10 +121,10 @@ nt]_[*@3 port], [@(0.0.255) int]_[*@3 listen`_count]_`=_[@3 5], [@(0.0.255) bool
|
|||
`=_[@(0.0.255) false], [@(0.0.255) bool]_[*@3 reuse]_`=_[@(0.0.255) true],
|
||||
[@(0.0.255) void`*]_[*@3 addr]_`=_NULL)&]
|
||||
[s5;:TcpSocket`:`:Listen`(const IpAddrInfo`&`,int`,int`,bool`,bool`): [@(0.0.255) bool]_
|
||||
[* Listen]([@(0.0.255) const]_[_^IpAddrInfo^ IpAddrInfo][@(0.0.255) `&]_[*@3 addr],
|
||||
[@(0.0.255) int]_[*@3 port], [@(0.0.255) int]_[*@3 listen`_count]_`=_[@3 5],
|
||||
[@(0.0.255) bool]_[*@3 ipv6]_`=_[@(0.0.255) false], [@(0.0.255) bool]_[*@3 reuse]_`=_[@(0.0.255) t
|
||||
rue])&]
|
||||
[* Listen]([@(0.0.255) const]_[_^topic`:`/`/Core`/src`/IpAddrInfo`$en`-us`#IpAddrInfo`:`:class^ I
|
||||
pAddrInfo][@(0.0.255) `&]_[*@3 addr], [@(0.0.255) int]_[*@3 port], [@(0.0.255) int]_[*@3 list
|
||||
en`_count]_`=_[@3 5], [@(0.0.255) bool]_[*@3 ipv6]_`=_[@(0.0.255) false],
|
||||
[@(0.0.255) bool]_[*@3 reuse]_`=_[@(0.0.255) true])&]
|
||||
[s2;%% Starts a listening server socket at [%-*@3 port] with input
|
||||
queue [%-*@3 listen`_count]. [%-*@3 ipv6] sets the socket to IPv6
|
||||
mode, [%-*@3 reuse] sets [^http`:`/`/www`.kernel`.org`/doc`/man`-pages`/online`/pages`/man7`/socket`.7`.html^ S
|
||||
|
|
@ -135,8 +136,8 @@ to be dereferenced and assigned to sockaddr`_in6`::sin6`_addr
|
|||
for ipv6`=`=true.&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Accept`(TcpSocket`&`): [@(0.0.255) bool]_[* Accept]([_^TcpSocket^ TcpSock
|
||||
et][@(0.0.255) `&]_[*@3 listen`_socket])&]
|
||||
[s5;:TcpSocket`:`:Accept`(TcpSocket`&`): [@(0.0.255) bool]_[* Accept]([_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[*@3 listen`_socket])&]
|
||||
[s2;%% Accepts a connection from [%-*@3 listen`_socket].&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
|
|
@ -161,7 +162,8 @@ switches SO`_LINGER off.&]
|
|||
[s2;%% Same as Linger(Null).&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Wait`(dword`): [@(0.0.255) bool]_[* Wait]([_^dword^ dword]_[*@3 events])&]
|
||||
[s5;:TcpSocket`:`:Wait`(dword`): [@(0.0.255) bool]_[* Wait]([_^topic`:`/`/Core`/src`/PrimitiveDataTypes`$en`-us`#Upp`:`:dword`:`:typedef^ d
|
||||
word]_[*@3 events])&]
|
||||
[s2;%% Waits for at most timeout for [%-*@3 events], which can be a
|
||||
combination of WAIT`_READ (wait for more input bytes available),
|
||||
WAIT`_WRITE (wait till it is possible to write something to socket).
|
||||
|
|
@ -197,7 +199,8 @@ do so at most for specified timeout. Returns the number of bytes
|
|||
actually read.&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Get`(int`): [_^String^ String]_[* Get]([@(0.0.255) int]_[*@3 len])&]
|
||||
[s5;:TcpSocket`:`:Get`(int`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* Get]([@(0.0.255) int]_[*@3 len])&]
|
||||
[s2;%% Reads at most [%-*@3 len] bytes, trying to do so at most for
|
||||
specified timeout. Returns a String with read data.&]
|
||||
[s3;%% &]
|
||||
|
|
@ -209,7 +212,7 @@ do so at most for specified timeout. Returns the number of bytes
|
|||
actually written.&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Put`(const String`&`): [@(0.0.255) int]_[* Put]([@(0.0.255) const]_[_^String^ S
|
||||
[s5;:TcpSocket`:`:Put`(const String`&`): [@(0.0.255) int]_[* Put]([@(0.0.255) const]_[_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring][@(0.0.255) `&]_[*@3 s])&]
|
||||
[s2;%% Writes [%-*@3 s], trying to do so at most for specified timeout.
|
||||
Returns the number of bytes actually written.&]
|
||||
|
|
@ -222,14 +225,15 @@ of bytes cannot be read until timeout, returns false and sets
|
|||
timeout error for TcpSocket.&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:GetAll`(int`): [_^String^ String]_[* GetAll]([@(0.0.255) int]_[*@3 len])&]
|
||||
[s5;:TcpSocket`:`:GetAll`(int`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetAll]([@(0.0.255) int]_[*@3 len])&]
|
||||
[s2;%% Reads exactly [%-*@3 len] bytes. If such number of bytes cannot
|
||||
be read until timeout, returns String`::GetVoid() and sets timeout
|
||||
error for TcpSocket.&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:GetLine`(int`): [_^String^ String]_[* GetLine]([@(0.0.255) int]_[*@3 maxlen
|
||||
]_`=_[@3 65536])&]
|
||||
[s5;:TcpSocket`:`:GetLine`(int`): [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* GetLine]([@(0.0.255) int]_[*@3 maxlen]_`=_[@3 65536])&]
|
||||
[s2;%% Reads single line (ended with `'`\n`', `'`\r`' is ignored).
|
||||
If the whole line cannot be read within timeout or line length
|
||||
is longer than [%-*@3 maxlen] sets error and returns String`::GetVoid().&]
|
||||
|
|
@ -243,7 +247,8 @@ false.&]
|
|||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:PutAll`(const String`&`): [@(0.0.255) bool]_[* PutAll]([@(0.0.255) const]_
|
||||
[_^String^ String][@(0.0.255) `&]_[*@3 s])&]
|
||||
[_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ String][@(0.0.255) `&]_[*@3 s
|
||||
])&]
|
||||
[s2;%% Outputs the whole String. If such number of bytes cannot be
|
||||
written in time specified by timeout, sets error and returns
|
||||
false.&]
|
||||
|
|
@ -266,23 +271,23 @@ period. Returns true if SSL handshake is (still) in progress.&]
|
|||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:SSLCertificate`(const String`&`,const String`&`,bool`): [@(0.0.255) v
|
||||
oid]_[* SSLCertificate]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 cert],
|
||||
[@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 pkey], [@(0.0.255) bool]_[*@3 asn1])
|
||||
&]
|
||||
oid]_[* SSLCertificate]([@(0.0.255) const]_[_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring][@(0.0.255) `&]_[*@3 cert], [@(0.0.255) const]_[_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring][@(0.0.255) `&]_[*@3 pkey], [@(0.0.255) bool]_[*@3 asn1])&]
|
||||
[s2;%% Sets the SSL certificate. Must be called before StartSSL.
|
||||
(Note that clients usually do not need certificates, this is
|
||||
usually used on accepting sockets.)&]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:GetSSLInfo`(`)const: [@(0.0.255) const]_[_^SSLInfo^ SSLInfo]_`*[* GetSSLI
|
||||
nfo]()_[@(0.0.255) const]&]
|
||||
[s5;:TcpSocket`:`:GetSSLInfo`(`)const: [@(0.0.255) const]_[_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#SSLInfo`:`:struct^ S
|
||||
SLInfo]_`*[* GetSSLInfo]()_[@(0.0.255) const]&]
|
||||
[s2;%% Returns information about established (after handshake) SSL
|
||||
connection or NULL if such information is not available.&]
|
||||
[s2;%% &]
|
||||
[s3;%% &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Timeout`(int`): [_^TcpSocket^ TcpSocket][@(0.0.255) `&]_[* Timeout]([@(0.0.255) i
|
||||
nt]_[*@3 ms])&]
|
||||
[s5;:TcpSocket`:`:Timeout`(int`): [_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[* Timeout]([@(0.0.255) int]_[*@3 ms])&]
|
||||
[s2;%% Sets timeout for all operations. Zero means that all operations
|
||||
return immediately (in that case it is usually a good idea to
|
||||
perform some sort of external blocking on socket or socket group
|
||||
|
|
@ -297,8 +302,8 @@ to adjust timeout before any single TcpSocket operation. Returns
|
|||
[s2;%% Returns current timeout.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:GlobalTimeout`(int`): [_^TcpSocket^ TcpSocket][@(0.0.255) `&]_[* GlobalTi
|
||||
meout]([@(0.0.255) int]_[*@3 ms])&]
|
||||
[s5;:TcpSocket`:`:GlobalTimeout`(int`): [_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[* GlobalTimeout]([@(0.0.255) int]_[*@3 ms])&]
|
||||
[s2;%% Sets the `"global timeout`". This timeout is in effect over
|
||||
a whole range of operations, until it is canceled by calling
|
||||
this method with Null parameter. If global timeout is exceeded,
|
||||
|
|
@ -306,17 +311,18 @@ operation during which it happened fails and socket error code
|
|||
is set to ERROR`_GLOBAL`_TIMEOUT.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:NoGlobalTimeout`(`): [_^TcpSocket^ TcpSocket][@(0.0.255) `&]_[* NoGlobalT
|
||||
imeout]()&]
|
||||
[s5;:TcpSocket`:`:NoGlobalTimeout`(`): [_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[* NoGlobalTimeout]()&]
|
||||
[s2;%% Same as GlobalTimeout(Null).&]
|
||||
[s3; &]
|
||||
[s4;%% &]
|
||||
[s5;:TcpSocket`:`:Blocking`(`): [_^TcpSocket^ TcpSocket][@(0.0.255) `&]_[* Blocking]()&]
|
||||
[s5;:TcpSocket`:`:Blocking`(`): [_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[* Blocking]()&]
|
||||
[s2;%% Same as Timeout(Null). Returns `*this.&]
|
||||
[s3;%% &]
|
||||
[s4; &]
|
||||
[s5;:TcpSocket`:`:WaitStep`(int`): [_^TcpSocket^ TcpSocket][@(0.0.255) `&]_[* WaitStep]([@(0.0.255) i
|
||||
nt]_[*@3 ms])&]
|
||||
[s5;:TcpSocket`:`:WaitStep`(int`): [_^topic`:`/`/Core`/src`/TcpSocket`$en`-us`#TcpSocket`:`:class^ T
|
||||
cpSocket][@(0.0.255) `&]_[* WaitStep]([@(0.0.255) int]_[*@3 ms])&]
|
||||
[s2;%% Sets the periodicity of calling WhenWait in millisecond between
|
||||
calls. Default is 10ms (100hz).&]
|
||||
[s3;%% &]
|
||||
|
|
@ -338,7 +344,8 @@ t]&]
|
|||
SSL connection.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cipher: [_^String^ String]_[* cipher]&]
|
||||
[s5;:SSLInfo`:`:cipher: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ Strin
|
||||
g]_[* cipher]&]
|
||||
[s2;%% Cipher used.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -346,19 +353,23 @@ SSL connection.&]
|
|||
[s2;%% Certificate is available.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cert`_subject: [_^String^ String]_[* cert`_subject]&]
|
||||
[s5;:SSLInfo`:`:cert`_subject: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* cert`_subject]&]
|
||||
[s2;%% Subject name.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cert`_issuer: [_^String^ String]_[* cert`_issuer]&]
|
||||
[s5;:SSLInfo`:`:cert`_issuer: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* cert`_issuer]&]
|
||||
[s2;%% Issuer name.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cert`_notbefore: [_^Date^ Date]_[* cert`_notbefore]&]
|
||||
[s5;:SSLInfo`:`:cert`_notbefore: [_^topic`:`/`/Core`/src`/DateTime`$en`-us`#Date`:`:struct^ D
|
||||
ate]_[* cert`_notbefore]&]
|
||||
[s2;%% Certificate is not valid before this date.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cert`_notafter: [_^Date^ Date]_[* cert`_notafter]&]
|
||||
[s5;:SSLInfo`:`:cert`_notafter: [_^topic`:`/`/Core`/src`/DateTime`$en`-us`#Date`:`:struct^ D
|
||||
ate]_[* cert`_notafter]&]
|
||||
[s2;%% Certificate is not valid after this date.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
|
|
@ -366,6 +377,7 @@ SSL connection.&]
|
|||
[s2;%% Version of certificate.&]
|
||||
[s3; &]
|
||||
[s4; &]
|
||||
[s5;:SSLInfo`:`:cert`_serial: [_^String^ String]_[* cert`_serial]&]
|
||||
[s5;:SSLInfo`:`:cert`_serial: [_^topic`:`/`/Core`/src`/String`$en`-us`#String`:`:class^ S
|
||||
tring]_[* cert`_serial]&]
|
||||
[s2;%% Serial number of certificate.&]
|
||||
[s3; ]]
|
||||
Loading…
Add table
Add a link
Reference in a new issue