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.

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

docs: add IPC doc #32059

Merged
merged 7 commits into from
Feb 9, 2022
Merged

docs: add IPC doc #32059

merged 7 commits into from
Feb 9, 2022

Conversation

erickzhao
Copy link
Member

Description of Change

See https://electronjsorg-new-pr-145.herokuapp.com/docs/latest/tutorial/ipc/ for preview.

Adds tutorial on IPC.

Checklist

Release Notes

Notes: none

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Nov 30, 2021
@erickzhao erickzhao requested a review from a team November 30, 2021 00:28
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Dec 1, 2021
Copy link
Contributor

@miniak miniak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are undoing changes from #31752

@erickzhao
Copy link
Member Author

Good catch @miniak, I'll address those soon.

Copy link
Member

@VerteDinde VerteDinde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great work, will help a lot of people! 👏 Good to go once the changes are addressed

@erickzhao erickzhao requested a review from Toinane January 6, 2022 17:55
Copy link
Member

@Toinane Toinane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 👍

@jkleinsc jkleinsc mentioned this pull request Jan 10, 2022
docs/tutorial/ipc.md Outdated Show resolved Hide resolved
docs/tutorial/ipc.md Outdated Show resolved Hide resolved
@jkleinsc
Copy link
Contributor

jkleinsc commented Feb 9, 2022

Merging as change is docs only, so Windows CI does not need to apply to this PR.

@jkleinsc jkleinsc merged commit e9a43be into electron:main Feb 9, 2022
@release-clerk
Copy link

release-clerk bot commented Feb 9, 2022

No Release Notes

@trop trop bot mentioned this pull request Feb 9, 2022
@trop
Copy link
Contributor

trop bot commented Feb 9, 2022

I have automatically backported this PR to "17-x-y", please check out #32840

@erickzhao erickzhao deleted the docs/ipc branch February 9, 2022 18:57
@Gyeop
Copy link

Gyeop commented Feb 13, 2022

I don't think ipcRendererEvent has a reply method. Could you please check it?
event.reply('counter-value', newValue) -> event.sender.send('counter-value', newValue)

@trop
Copy link
Contributor

trop bot commented Apr 12, 2022

@erickzhao has manually backported this PR to "18-x-y", please check out #33748

@Cono52
Copy link

Cono52 commented Jul 3, 2022

I would love if a small paragraph/warning was added to this with regards to the limitations of using the IPC process for real-time levels of performance.
I only have anecdotal expeirence of getting real-time data i.e. a high-frequency websocket off of the main-thread and move it to the place the main thread was sending it to, via IPC. This, way we avoided the structure copying of all these objects and whatever else happens which would slow everything down. My main rule has usually been use it only for "user initiated" message passing, as oppose to hooking it up to something firing 10 times a second.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants