Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add developer documents #1830

Closed
wants to merge 1 commit into from
Closed

Add developer documents #1830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/Developer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Developer documents

## Edit image

I am use diagrams to edit the image.

- New a image
- Open https://app.diagrams.net/ in the browser.
- Select menu `File->New`
- Edit a exist image
- Open https://app.diagrams.net/ in the browser.
- Select `menu File->From ...`
- Save
- Save the .drawio to doc/app.diagrams.net folder.
- Export the .svg to doc/image folder.

**Note**: The base name must be same.
- Use the image
- Use the .svg file in the image directory in your document.

## Server class relation

![Server class relation](image/ServerClassRelation.svg "Server class relation")
94 changes: 94 additions & 0 deletions doc/app.diagrams.net/ServerClassRelation.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:130.0) Gecko/20100101 Firefox/130.0" version="24.7.10">
<diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
<mxGraphModel dx="846" dy="478" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
<mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
<mxCell id="yhpifudhl0eZlyL10YCA-0" value="SDesktop" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="80" y="140" width="200" height="52" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-24" value="+ init(rfb::VNCServer* vs): void" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="yhpifudhl0eZlyL10YCA-0">
<mxGeometry y="26" width="200" height="26" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-14" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endArrow=block;endFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="yhpifudhl0eZlyL10YCA-4" target="yhpifudhl0eZlyL10YCA-0" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-4" value="XserverDesktop" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="100" y="320" width="160" height="52" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-5" value="+ server: VNCServer" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="yhpifudhl0eZlyL10YCA-4" vertex="1">
<mxGeometry y="26" width="160" height="26" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-32" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;endArrow=none;endFill=0;startArrow=block;startFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="yhpifudhl0eZlyL10YCA-19" target="yhpifudhl0eZlyL10YCA-28" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-19" value="VNCServer" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="414" y="139" width="160" height="34" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-28" value="VNCServerST" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="369" y="305" width="250" height="78" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-6" value="- desktop: SDesktop*" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="yhpifudhl0eZlyL10YCA-28">
<mxGeometry y="26" width="250" height="26" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-29" value="- clients: std::list&amp;lt;VNCSConnectionST*&amp;gt;" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="yhpifudhl0eZlyL10YCA-28" vertex="1">
<mxGeometry y="52" width="250" height="26" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-43" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;endArrow=none;endFill=0;startArrow=block;startFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="yhpifudhl0eZlyL10YCA-36" target="yhpifudhl0eZlyL10YCA-42" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-3" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="yhpifudhl0eZlyL10YCA-36" target="4XOMzHr4IZn1yieCZoJJ-1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-36" value="SConnection" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="727" y="140" width="318" height="76" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-52" value="+ processMsg(): void" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="yhpifudhl0eZlyL10YCA-36" vertex="1">
<mxGeometry y="26" width="318" height="24" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-4" value="+ setStreams(rdr::InStream* is, rdr::OutStream* os): void" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="yhpifudhl0eZlyL10YCA-36">
<mxGeometry y="50" width="318" height="26" as="geometry" />
</mxCell>
<mxCell id="yhpifudhl0eZlyL10YCA-42" value="VNCSConnectionST" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
<mxGeometry x="761" y="305" width="250" height="78" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-25" value="+ processMessages(): void" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="yhpifudhl0eZlyL10YCA-42">
<mxGeometry y="26" width="250" height="26" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-26" value="- server: VNCServerST*" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="yhpifudhl0eZlyL10YCA-42">
<mxGeometry y="52" width="250" height="26" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-1" value="SMsgHandler" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
<mxGeometry x="761" y="8" width="250" height="52" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-2" value="- client: ClientParams" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" vertex="1" parent="4XOMzHr4IZn1yieCZoJJ-1">
<mxGeometry y="26" width="250" height="26" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-12" value="" style="endArrow=none;endFill=0;html=1;edgeStyle=orthogonalEdgeStyle;align=left;verticalAlign=top;rounded=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="yhpifudhl0eZlyL10YCA-29" target="4XOMzHr4IZn1yieCZoJJ-26">
<mxGeometry x="-1" relative="1" as="geometry">
<mxPoint x="640" y="370" as="sourcePoint" />
<mxPoint x="750" y="270" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-13" value="&amp;nbsp;0..n" style="edgeLabel;resizable=0;html=1;align=left;verticalAlign=bottom;" connectable="0" vertex="1" parent="4XOMzHr4IZn1yieCZoJJ-12">
<mxGeometry x="-1" relative="1" as="geometry" />
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-27" value="1" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="4XOMzHr4IZn1yieCZoJJ-12">
<mxGeometry x="0.8265" y="4" relative="1" as="geometry">
<mxPoint y="-8" as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.25;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="4XOMzHr4IZn1yieCZoJJ-6" target="yhpifudhl0eZlyL10YCA-0">
<mxGeometry relative="1" as="geometry">
<mxPoint x="310" y="270" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="4XOMzHr4IZn1yieCZoJJ-21" value="1" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="4XOMzHr4IZn1yieCZoJJ-20">
<mxGeometry x="-0.9086" y="-3" relative="1" as="geometry">
<mxPoint y="-10" as="offset" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
4 changes: 4 additions & 0 deletions doc/image/ServerClassRelation.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading