excellent
I like when classes has these kinds of comments.

stef

On Aug 7, 2009, at 8:55 AM, Miguel Enrique Cobá Martinez wrote:

> I forgot the text:
>
>> I duplicate here part of the RFBServer class comment for the  
>> examples of
>> use:
>>
>>
> ** CONTROL THE SERVER WITH A MENU
>
> The easiest way to configure and control the server is to open the  
> menu:
>
>       RFBServerGUI open
>
> (which you can pin to the desktop if you like).
>
>
>
> ** CONTROL THE SERVER WITH CONVENIENCE METHODS
>
> There are handy methods to quickly start/stop the server (using the
> default preferences and allowing empty
> passwords).
>
> To start the server on the default display #0
>
>     RFBServer start
>
> To start the server on other display:
>
>     RFBServer start: 1
>
> To stop the server:
>
>       RFBServer stop.
>       
>       
>       
> ** CONTROL THE SERVER PROGRAMMATICALLY
>
> The PREFERED way to interact, configure and control the server is
> programmatically.
>
> The server is implemented as a singleton because only a server can run
> at any time.
> Access the singleton with:
>
>     RFBServer current
>
> You can completely configure the server by sending messages to the
> singleton.  The most important of these is:
>
>       RFBServer current configureForMemoryConservation
>       
> that set the preferences in a way to conserve memory on the server  
> side.
>
> To set the view-only and full (interactive) passwords:
>
>       RFBServer current setFullPassword: aFullPassword.
>       RFBServer current setViewPassword: aViewPassword.
>       
> To disable the empty passwords
>
>       RFBServer current allowEmptyPasswords: false.
>       
> To reset the preferences to their default values:
>
>       RFBServer current initializePreferences.
>       
> To start the server on a given display:
>
>       RFBServer current start: aDisplayNumber.
>       
> To stop the server:
>
>       RFBServer current stop.
>       
> This is a full example for configuring the server by code:
>
>       RFBServer current
>               initializePreferences;
>               configureForMemoryConservation;
>               allowEmptyPasswords: false;
>               setFullPassword: 'secret';
>               setViewPassword: 'secret too';
>               start: 0.
>
> See the comments in the methods of the RFBServer for more options.
>
> The version on Lukas repo is:
>
> RFB-MiguelCoba.26.mcz
>
> Cheers,
> Miguel Cobá
>
>
> _______________________________________________
> Pharo-project mailing list
> [email protected]
> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project


_______________________________________________
Pharo-project mailing list
[email protected]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project

Reply via email to